|
| 1 | +# Super CLI |
| 2 | + |
| 3 | +One VS Code extension to launch any coding agent CLI — **Claude Code, Codex, GitHub Copilot CLI, |
| 4 | +Gemini, Grok, Kilo, Antigravity, and your own** — from a single sidebar and a side terminal. |
| 5 | + |
| 6 | +Works on Windows, macOS, and Linux, and across the VS Code family (VS Code, Cursor, Antigravity, |
| 7 | +Windsurf). |
| 8 | + |
| 9 | +This extension is unofficial and is not affiliated with, endorsed by, or sponsored by Anthropic, |
| 10 | +OpenAI, GitHub, Google, or any other vendor. |
| 11 | + |
| 12 | +## Features |
| 13 | + |
| 14 | +- **One launcher for every agent.** A **Super CLI** view in the activity bar lists all configured |
| 15 | + agents; click one to open it in a terminal beside your editor. A toolbar button and the |
| 16 | + **Super CLI: Launch Coding Agent** command open a quick pick of the same list. |
| 17 | +- **Built-in presets.** Claude Code, Codex, GitHub Copilot CLI, Gemini, Grok, Kilo, and Antigravity |
| 18 | + are available out of the box. |
| 19 | +- **Add your own, no code required.** Define new agents in `settings.json`. The sidebar updates |
| 20 | + automatically. |
| 21 | +- **Native integrated terminal.** Each agent runs in a real VS Code terminal, inheriting your |
| 22 | + shell, `PATH`, and environment. No bundled emulator, no runtime dependencies. |
| 23 | + |
| 24 | +## Adding or overriding an agent |
| 25 | + |
| 26 | +Add agents through the `superCli.agents` setting. Each entry creates a new agent, or — when it |
| 27 | +reuses a built-in `id` — overrides that built-in (for example to point at a custom binary path). |
| 28 | + |
| 29 | +```json |
| 30 | +"superCli.agents": [ |
| 31 | + { |
| 32 | + "id": "my-agent", |
| 33 | + "label": "My Agent", |
| 34 | + "command": "my-agent", |
| 35 | + "icon": "rocket", |
| 36 | + "installCommand": "npm install -g my-agent", |
| 37 | + "autoInstall": false |
| 38 | + }, |
| 39 | + { |
| 40 | + "id": "claude", |
| 41 | + "label": "Claude Code", |
| 42 | + "command": "\"C:\\Tools\\claude\\claude.exe\"" |
| 43 | + } |
| 44 | +] |
| 45 | +``` |
| 46 | + |
| 47 | +- `id` — unique identifier; reuse a built-in id to override it. |
| 48 | +- `label` — name shown in the sidebar and quick pick. |
| 49 | +- `command` — the command that starts the CLI. On Windows, quote executable paths that contain |
| 50 | + spaces. |
| 51 | +- `icon` — optional [ThemeIcon](https://code.visualstudio.com/api/references/icons-in-labels) id, |
| 52 | + e.g. `sparkle` or `rocket`. |
| 53 | +- `installCommand` / `autoInstall` — optional; when the command is missing and `autoInstall` is |
| 54 | + `true`, the launcher offers a guided install after explicit confirmation. |
| 55 | + |
| 56 | +Only the user (global) value of `superCli.agents` is used; workspace overrides are ignored so that |
| 57 | +an untrusted repository cannot inject commands. |
| 58 | + |
| 59 | +## Configuration |
| 60 | + |
| 61 | +| Setting | Default | Description | |
| 62 | +| --- | --- | --- | |
| 63 | +| `superCli.agents` | `[]` | Your agents (added to or overriding the built-ins). | |
| 64 | +| `superCli.useBuiltins` | `true` | Include the built-in agent presets. | |
| 65 | +| `superCli.terminalLocation` | `beside` | Open the terminal `beside` the editor or in the `panel`. | |
| 66 | + |
| 67 | +Run **Super CLI: Open Settings** from the sidebar or the command palette to jump straight to these |
| 68 | +settings. |
| 69 | + |
| 70 | +## Troubleshooting |
| 71 | + |
| 72 | +- **"… could not be started."** The configured `command` was not found. Install the CLI, or fix the |
| 73 | + command in settings. The launcher uses the active editor's workspace folder as the working |
| 74 | + directory. |
| 75 | +- **Nothing happens on launch.** Make sure the workspace is trusted — the launcher is disabled in |
| 76 | + untrusted workspaces because it runs terminal commands. |
| 77 | + |
| 78 | +## Privacy |
| 79 | + |
| 80 | +This extension does not collect telemetry, analytics, or personal data. It only runs the commands |
| 81 | +you configure, in your own integrated terminal. |
| 82 | + |
| 83 | +## Building |
| 84 | + |
| 85 | +```bash |
| 86 | +npm install |
| 87 | +npm run check # compile + unit tests + VS Code integration smoke test |
| 88 | +npm run package # produce the .vsix |
| 89 | +``` |
0 commit comments