docs(kilo-docs): clarify VS Code extension local launch - #11663
Conversation
|
@singhvishalkr is attempting to deploy a commit to the Kilo Code Team on Vercel. A member of the Team first needs to authorize it. |
| |---|---| | ||
| | `--no-build` | Launch the extension host without rebuilding first | | ||
| | `--app-path <path>` | Point to a specific VS Code executable | | ||
| | `VSCODE_EXEC_PATH=<path>` | Set the VS Code executable through the environment | |
There was a problem hiding this comment.
WARNING: POSIX-only environment syntax in a cross-platform docs table
VSCODE_EXEC_PATH=<path> is shell-assignment syntax that works in bash/zsh, but not in PowerShell or cmd.exe. Because this section explicitly calls out Windows support, a Windows contributor copying this row can end up with a failing command. Could we either describe this as the env var name only, like CONTRIBUTING.md, or add the Windows form separately?
| | `VSCODE_EXEC_PATH=<path>` | Set the VS Code executable through the environment | | |
| | `VSCODE_EXEC_PATH` | Set the VS Code executable through the environment | |
Reply with @kilocode-bot fix it to have Kilo Code address this issue.
Code Review SummaryStatus: 1 Issue Found | Recommendation: Address before merge Overview
Issue Details (click to expand)WARNING
Fix these issues in Kilo Cloud Files Reviewed (1 files)
Previous Review Summary (commit f92e9a6)Current summary above is authoritative. Previous snapshots are kept for context only. Previous review (commit f92e9a6)Status: 1 Issue Found | Recommendation: Address before merge Overview
Issue Details (click to expand)WARNING
Fix these issues in Kilo Cloud Files Reviewed (1 files)
Reviewed by gpt-5.4-20260305 · Input: 55.4K · Output: 4.4K · Cached: 134.2K Review guidance: REVIEW.md from base branch |
|
Updated in I changed the table row so it names Verification:
|
* docs(kilo-docs): document VS Code extension local launch * docs(kilo-docs): add Windows extension env example
Issue
Closes #11654
Context
A contributor asked how to build and run the VS Code extension locally. The development environment page already listed
bun run extension, but it did not explain what the command launches or how to point it at a specific VS Code install or workspace.Implementation
Expanded the VS Code extension section with the local launch options supported by the repo command, including
--no-build,--app-path,VSCODE_EXEC_PATH,--insiders,--workspace, and--clean. Added one workspace example and a short note on where to check startup errors.Screenshots / Video
N/A - docs text only.
How to Test
Manual/local verification
packages/kilo-docs/pages/contributing/development-environment.mdfor Markdoc/Markdown syntax.git diff --check.Reviewer test steps
/docs/contributing/development-environment.Running the Extension.bun run extension, the supported launch options, and the workspace example.Blocked checks and substitute verification
bun run script/check-md-table-padding.ts --fixcould not be run becausebunis not installed in this Windows session.bun run --filter @kilocode/kilo-docs testandbun run --filter @kilocode/kilo-docs buildcould not be run for the same reason.git diff --checkplus manual Markdown table and link review.Checklist