From 188edee609acfa342da3f41d6f692f309cc93b8f Mon Sep 17 00:00:00 2001 From: Steven Hugg Date: Tue, 29 Sep 2026 14:52:04 +0200 Subject: [PATCH] vscode: cli off by default --- extension/README.md | 5 +++-- extension/docs/building.md | 6 +++--- extension/package.json | 2 +- extension/src/terminalcli.ts | 3 ++- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/extension/README.md b/extension/README.md index 9523644f..e7036de1 100644 --- a/extension/README.md +++ b/extension/README.md @@ -53,7 +53,8 @@ To use code you already have, open its folder: the extension detects the appropr AI agents can build and test your program too. Agents that use VS Code's tools, such as Copilot's agent mode, get **Build 8bitworkshop Program** and **Run 8bitworkshop Program**, which returns a screenshot. Agents in the -terminal, such as Claude Code, use the `8bws` command. See +terminal, such as Claude Code, use the `8bws` command, once you turn on +`8bitworkshop.terminalCommand`. See [AI agents and the terminal](docs/building.md#ai-agents). ## Settings @@ -77,7 +78,7 @@ Your local user settings: | `8bitworkshop.exportRom` | Write each successful build's ROM to the export folder | | `8bitworkshop.toolchainPath` | Use a local 8bitworkshop checkout instead of the included toolchains | | `8bitworkshop.assetUrl` | Server or local directory to download toolchains from, tried before the default servers | -| `8bitworkshop.terminalCommand` | Add the `8bws` command to the integrated terminal (on by default) | +| `8bitworkshop.terminalCommand` | Add the `8bws` command to the integrated terminal (off by default) | ## Commands diff --git a/extension/docs/building.md b/extension/docs/building.md index 52e765da..c7175801 100644 --- a/extension/docs/building.md +++ b/extension/docs/building.md @@ -77,7 +77,8 @@ Agents in the terminal use the `8bws` command below. ## Building from the terminal -VS Code's integrated terminal has an `8bws` command that builds and runs +With `8bitworkshop.terminalCommand` turned on (it's off by default), VS +Code's integrated terminal has an `8bws` command that builds and runs programs with the same toolchains and emulators as the extension. It needs no Node.js install. Scripts and AI agents that run in the terminal, such as Claude Code, can use it to check their work: @@ -98,8 +99,7 @@ the examples, as they do in the editor. The command is a launcher script in the extension's storage folder, which the extension adds to `PATH` for each new terminal. Terminals opened -before the extension started don't have it; open a new one. To turn it -off, set `8bitworkshop.terminalCommand` to `false`. The first run in a +before it was turned on don't have it; open a new one. The first run in a while may take a few seconds while it unpacks the toolchains. ## Where included files come from diff --git a/extension/package.json b/extension/package.json index b462e81d..e4b4054b 100644 --- a/extension/package.json +++ b/extension/package.json @@ -334,7 +334,7 @@ }, "8bitworkshop.terminalCommand": { "type": "boolean", - "default": true, + "default": false, "markdownDescription": "Add the `8bws` command to the integrated terminal, to build and run programs from the command line or an AI agent. Open a new terminal after changing this." }, "8bitworkshop.exportRom": { diff --git a/extension/src/terminalcli.ts b/extension/src/terminalcli.ts index 3e665435..d29e550e 100644 --- a/extension/src/terminalcli.ts +++ b/extension/src/terminalcli.ts @@ -72,7 +72,8 @@ A ${platform.name} program made with [8bitworkshop](${link}). In VS Code with the 8bitworkshop extension, open \`${mainFile}\` and click **Run**. -From VS Code's integrated terminal, in this folder: +From VS Code's integrated terminal, in this folder (turn on the +\`8bitworkshop.terminalCommand\` setting first): \`\`\`sh # compile to a ROM