Skip to content

docs(kilo-docs): clarify VS Code extension local launch - #11663

Merged
johnnyeric merged 3 commits into
Kilo-Org:mainfrom
singhvishalkr:docs/vscode-extension-local-dev
Jun 30, 2026
Merged

docs(kilo-docs): clarify VS Code extension local launch#11663
johnnyeric merged 3 commits into
Kilo-Org:mainfrom
singhvishalkr:docs/vscode-extension-local-dev

Conversation

@singhvishalkr

Copy link
Copy Markdown
Contributor

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

  • Reviewed packages/kilo-docs/pages/contributing/development-environment.md for Markdoc/Markdown syntax.
  • Ran git diff --check.

Reviewer test steps

  1. Open /docs/contributing/development-environment.
  2. Go to Running the Extension.
  3. Confirm the section explains bun run extension, the supported launch options, and the workspace example.

Blocked checks and substitute verification

  • bun run script/check-md-table-padding.ts --fix could not be run because bun is not installed in this Windows session.
  • bun run --filter @kilocode/kilo-docs test and bun run --filter @kilocode/kilo-docs build could not be run for the same reason.
  • Substitute verification was git diff --check plus manual Markdown table and link review.

Checklist

  • Issue linked above, or exception explained
  • Tests/verification described
  • Screenshots/video included for visual changes, or marked N/A
  • Changeset considered for user-facing changes
  • I personally reviewed the diff and can explain the changes.

@vercel

vercel Bot commented Jun 24, 2026

Copy link
Copy Markdown

@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 |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Suggested change
| `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.

@kilo-code-bot

kilo-code-bot Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Code Review Summary

Status: 1 Issue Found | Recommendation: Address before merge

Overview

Severity Count
CRITICAL 0
WARNING 1
SUGGESTION 0
Issue Details (click to expand)

WARNING

File Line Issue
packages/kilo-docs/pages/contributing/development-environment.md 118 VSCODE_EXEC_PATH=<path> uses POSIX-only syntax in a section that claims Windows support.

Fix these issues in Kilo Cloud

Files Reviewed (1 files)
  • packages/kilo-docs/pages/contributing/development-environment.md - 1 issue
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

Severity Count
CRITICAL 0
WARNING 1
SUGGESTION 0
Issue Details (click to expand)

WARNING

File Line Issue
packages/kilo-docs/pages/contributing/development-environment.md 118 VSCODE_EXEC_PATH=<path> uses POSIX-only syntax in a section that claims Windows support.

Fix these issues in Kilo Cloud

Files Reviewed (1 files)
  • packages/kilo-docs/pages/contributing/development-environment.md - 1 issue

Reviewed by gpt-5.4-20260305 · Input: 55.4K · Output: 4.4K · Cached: 134.2K

Review guidance: REVIEW.md from base branch main

@singhvishalkr

Copy link
Copy Markdown
Contributor Author

Updated in a6dbc0f17.

I changed the table row so it names VSCODE_EXEC_PATH without POSIX-only assignment syntax, then added separate macOS/Linux and Windows PowerShell examples below it.

Verification:

  • git diff --check

@johnnyeric
johnnyeric merged commit 069c8d1 into Kilo-Org:main Jun 30, 2026
20 of 21 checks passed
t7tran pushed a commit to t7tran/kilocode that referenced this pull request Aug 14, 2026
* docs(kilo-docs): document VS Code extension local launch

* docs(kilo-docs): add Windows extension env example
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

VS Code plugins documentation

2 participants