Skip to content

jugyo/polish-it

Repository files navigation

Polish It

A VSCode extension that polishes selected text using LLM.

Features

  • Polish Selection: Select text and polish it with AI
  • Context-Aware: Uses file context to apply appropriate improvements
  • Real-time Streaming: See improvements appear in real-time as they're generated

Installation

From VSCode Marketplace

Coming soon

Manual Installation (from .vsix file)

  1. Build the extension package:

    npm install
    npm run package
  2. Install the generated .vsix file:

    code --install-extension polish-it-0.1.0.vsix

    Or in VSCode:

    • Open Command Palette (Cmd+Shift+P)
    • Run "Extensions: Install from VSIX..."
    • Select the .vsix file

Configuration

Open VSCode Settings and search for "Polish It":

Setting Description Default
polishIt.openai.apiKey Your OpenAI API key ""
polishIt.openai.model Model to use (e.g., gpt-4o-mini, gpt-4o) "gpt-4o-mini"
polishIt.openai.baseUrl API base URL (for custom endpoints) "https://api.openai.com/v1"

Usage

Command Palette

  1. Select text
  2. Open Command Palette (Cmd+Shift+P / Ctrl+Shift+P)
  3. Run "Polish"

Keyboard Shortcut

  • Mac: Cmd+Shift+I
  • Windows/Linux: Ctrl+Shift+I

Context Menu

  1. Select text
  2. Right-click
  3. Click "Polish"

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •