Getting Started

Introduction

SuperCoder is a powerful coding agent that runs in your terminal, assisting you with various development tasks. It uses AI to help search, navigate, edit, and improve your codebase through natural language commands.

Installation

1. Download the ZIP bundle from the Releases page
2. Extract to a folder on your computer
3. Make sure the bin/supercoder (or bin/supercoder.bat on Windows) binary is accessible in your system's PATH

Configuration

SuperCoder requires configuration before use. You have two main options for configuring the agent:

Option 1: Using OpenAI API

Set the following environment variables:

export OPENAI_API_KEY=<YOUR_API_KEY>
export OPENAI_MODEL=<MODEL>  # defaults to "o3-mini" if not specified

You can obtain an API key by signing up at OpenAI.

Option 2: Using Local Models or OpenAI-compatible API

If you prefer using a local model or any other OpenAI-compatible API, configure:

export SUPERCODER_BASE_URL=<API_URL>
export SUPERCODER_API_KEY=<API_KEY>
export SUPERCODER_MODEL=<MODEL_NAME>

For example, use this config if you want to use Supercoder with LM Studio:

export SUPERCODER_BASE_URL=http://localhost:1234/v1
export SUPERCODER_API_KEY=you-dont-need-it
export SUPERCODER_MODEL=qwen2.5-coder-32b-instruct

Usage

Navigate to the project directory you want to work on and run:

supercoder

You can customize your experience with these command line options:

supercoder [options]

Options:
  -c, --use-cursor-rules <true/false>  Use Cursor rules for the agent
  -m, --model <model>                  Model to use for the agent
  -d, --debug <true/false>             Enable debug mode
  --help                               Show usage information