Skip to content

INSTALL.md

Latest commit

 

History

History
72 lines (50 loc) · 1.55 KB

INSTALL.md

File metadata and controls

72 lines (50 loc) · 1.55 KB

Install GPT Rewriter

Quick Install

Step 1: Clone the Repository

git clone https://github.com/alshimo/GPTRewriter.git
cd GPTRewriter

Step 2: Install Dependencies

npm install

Or use the setup script (auto-installs Node.js if needed):

./setup.sh

Step 3: Start Development Mode

npm run dev

This will:

  • Start the Raycast development server
  • Automatically load the extension in Raycast
  • Watch for changes and reload automatically

Step 4: Configure API Keys

  1. Open Raycast (Cmd+Space)
  2. Type "Settings" (from GPT Rewriter extension)
  3. Add your OpenAI API Key (required)
  4. Optionally add OpenRouter API Key
  5. Configure your preferred model and settings

Done! 🎉

Note: Keep npm run dev running while you use the extension. The extension works in development mode.

What You Need

  • macOS (Raycast is macOS-only)
  • Node.js 18+ (Download or auto-installed via Homebrew with ./setup.sh)
  • Raycast app (Download)
  • OpenAI API Key (Get one here)

Troubleshooting

npm run dev not working?

  • Make sure Node.js is installed: node -v (should be 18+)
  • Make sure dependencies are installed: npm install
  • Check if Raycast is running

Extension not appearing?

  • Make sure npm run dev is running
  • Restart Raycast
  • Check the terminal for error messages

Need more help?