@@ -21,6 +21,16 @@ model — VS Code itself plus the forks that install from [Open VSX](https://ope
2121or from a ` .vsix ` , such as Cursor, Windsurf, Google Antigravity, Kiro, Trae, VSCodium, and Gitpod. It
2222is free, open source, and has no telemetry or automatic CLI installers.
2323
24+ ## Requirements
25+
26+ - VS Code ` 1.93 ` or newer, or a compatible desktop editor that can install VS Code extensions.
27+ - At least one supported coding-agent CLI installed and authenticated according to that vendor's
28+ documentation. Super CLI never installs or configures the CLI for you.
29+ - A trusted workspace before launch, update, or version commands can run.
30+
31+ Node.js and npm are required only for developing or packaging Super CLI, not for installing the
32+ extension or launching an agent.
33+
2434## Install Super CLI in VS Code
2535
2636[ Install Super CLI from the Visual Studio Marketplace] ( https://marketplace.visualstudio.com/items?itemName=mikesoft.vscode-super-cli ) ,
@@ -53,6 +63,18 @@ This extension is unofficial and is not affiliated with, endorsed by, or sponsor
5363OpenAI, GitHub, Google, or any other vendor. See the [ third-party
5464notices] ( TRADEMARKS.md ) .
5565
66+ ## Quick start
67+
68+ 1 . Install and authenticate the coding-agent CLI you want to use.
69+ 2 . Install Super CLI, open a folder, and trust the workspace after reviewing it.
70+ 3 . Open ** Super CLI** from the activity bar and select an agent, or run ** Super CLI: Launch Coding
71+ Agent** from the Command Palette.
72+ 4 . Optionally star one or more agents and use ` Ctrl+Alt+A ` (` Cmd+Alt+A ` on macOS) for fast access.
73+
74+ The selected command runs in a native integrated terminal with the active workspace folder as its
75+ working directory. Super CLI does not proxy the CLI or replace the agent's own authentication and
76+ settings.
77+
5678## Interface
5779
5880### Agent sidebar and editor launcher
@@ -171,9 +193,9 @@ reuses a built-in `id` — overrides that built-in (for example to point at a cu
171193 paths that contain spaces.
172194- ` icon ` — optional [ ThemeIcon] ( https://code.visualstudio.com/api/references/icons-in-labels ) id,
173195 e.g. ` sparkle ` or ` rocket ` .
174- - ` installationDocumentationUrl ` — optional verified official installation documentation URL. When
175- the command is missing, Super CLI offers to open this URL in your external browser; it does not run
176- any installation command.
196+ - ` installationDocumentationUrl ` — optional verified official HTTPS installation documentation URL.
197+ Credential-bearing URLs and non-HTTPS schemes are ignored. When the command is missing, Super CLI
198+ offers to open the URL in your external browser; it does not run any installation command.
177199- ` env ` — optional environment variables set for the agent's terminal, e.g. to opt out of a CLI's
178200 IDE-extension auto-install via its own variable: ` { "CLAUDE_CODE_IDE_SKIP_AUTO_INSTALL": "1" } ` .
179201- ` updateCommand ` — optional command to update the CLI. It accepts the same cross-platform string or
@@ -188,6 +210,16 @@ the command runs inside WSL.
188210Only the user (global) value of ` superCli.agents ` is used; workspace overrides are ignored so that
189211an untrusted repository cannot inject commands.
190212
213+ ### Environment variables and secrets
214+
215+ Super CLI itself requires no environment variables and does not load ` .env ` files. The optional
216+ ` env ` object on a custom agent applies only to that agent's terminal; executable detection uses the
217+ same overrides so a custom ` PATH ` is reflected in the sidebar status.
218+
219+ Keep credentials in the CLI vendor's supported credential store or in your normal shell environment.
220+ Do not commit secrets in settings, command strings, or environment files. ` .env ` variants are ignored
221+ by Git and explicitly excluded from VSIX packages as a defensive safeguard.
222+
191223## Configuration
192224
193225| Setting | Default | Description |
@@ -269,8 +301,9 @@ Windows, macOS, Linux, or WSL command variant.
269301### Which AI coding agents are supported?
270302
271303Claude Code, Codex, GitHub Copilot CLI, Grok, Kilo, Kiro, OpenClaw, Antigravity, OpenCode, Command
272- Code, Cursor, Devin CLI, Droid, Crush, Hermes, MiMo Code, Pi, Kimi Code CLI, Qoder CLI, and Qwen Code
273- CLI out of the box — plus any CLI you add in ` settings.json ` .
304+ Code, Cursor, Devin CLI, Droid, Crush, Hermes, MiMo Code, Pi, Kimi Code CLI, Qoder CLI, Qwen Code CLI,
305+ Amp, OpenClaude, Oh My Pi, goose, Auggie CLI, Cline CLI, Codebuff, Continue CLI, Mistral Vibe, and Rovo
306+ Dev CLI out of the box — plus any CLI you add in ` settings.json ` .
274307
275308### Does Super CLI work on Windows, macOS, Linux, and WSL?
276309
@@ -286,6 +319,8 @@ integrated terminal.
286319If Super CLI is useful to you, consider [ sponsoring its development] ( https://github.com/sponsors/TheStreamCode ) .
287320Bug reports, feature requests, and contributions are welcome on
288321[ GitHub] ( https://github.com/TheStreamCode/super-cli ) .
322+ Report suspected vulnerabilities privately according to [ SECURITY.md] ( SECURITY.md ) , not in a public
323+ issue.
289324
290325## Privacy
291326
@@ -298,10 +333,47 @@ show the one-time rating nudge described above — neither is ever transmitted a
298333Keep credentials in each CLI's supported credential store or environment configuration rather than
299334embedding them directly in launch, update, or version command strings.
300335
301- ## Building
336+ ## Development
337+
338+ Development requires Node.js 22, npm, and VS Code 1.93 or newer. The repository includes ` .nvmrc ` for
339+ Node version managers. Install the exact locked dependency tree before working:
302340
303341``` bash
304342npm ci
305- npm run check # compile + unit tests + VS Code integration smoke test
306- npm run package # produce the .vsix
307343```
344+
345+ Press ` F5 ` in VS Code to compile and open an Extension Development Host, or use these scripts:
346+
347+ | Command | Purpose |
348+ | --- | --- |
349+ | ` npm run compile ` | Compile strict TypeScript from ` src/ ` to ` out/ ` . |
350+ | ` npm run typecheck ` | Run strict TypeScript checks without emitting files. |
351+ | ` npm run watch ` | Recompile TypeScript while files change. |
352+ | ` npm run test:unit ` | Compile and run the fast ` node:test ` unit suite. |
353+ | ` npm run test:integration ` | Compile and launch the real VS Code Extension Development Host smoke test. |
354+ | ` npm run check ` | Run compile, unit tests, integration tests, and the VSIX file-list dry run used by CI. |
355+ | ` npm run audit ` | Check the complete dependency tree for moderate-or-higher known vulnerabilities. |
356+ | ` npm run package ` | Compile and create an installable ` .vsix ` . |
357+
358+ There is no separate linter: ` tsc --strict ` , ` noUnusedLocals ` , and ` noUnusedParameters ` are the static
359+ quality gate. Unit tests execute compiled files from ` out/ ` , never TypeScript source directly. See
360+ [ CONTRIBUTING.md] ( CONTRIBUTING.md ) for code, test, branding, and pull-request conventions.
361+
362+ ## Build and distribution
363+
364+ Before producing a release artifact, run the same gates as CI and inspect the VSIX contents:
365+
366+ ``` bash
367+ npm ci
368+ npm run audit
369+ npm run check
370+ npm run package
371+ ```
372+
373+ For this project, deployment means publishing the reviewed VSIX rather than deploying a server. A
374+ maintainer updates ` package.json ` , ` package-lock.json ` , ` CHANGELOG.md ` , and ` CITATION.cff ` together,
375+ installs the generated VSIX in a clean Extension Development Host, then publishes that same artifact
376+ to the Visual Studio Marketplace, Open VSX, and the matching GitHub release. Publishing credentials
377+ belong in the platform's secret store or local credential manager and must never be committed.
378+
379+ The complete maintainer checklist is in [ CONTRIBUTING.md] ( CONTRIBUTING.md#release-checklist-maintainers ) .
0 commit comments