Grok Build Community Edition

Community VS Code host for Grok Build: a thin TypeScript client that speaks ACP to grok agent stdio. The agent runtime stays in Rust.

Do not reimplement the agent. Spawn grok agent stdio, speak ACP, map VS Code primitives.

Install (users)

Or in the editor: Extensions → search “Grok Build Community Edition” (publisher tienpham).

Prerequisites

1. VS Code 1.93+ (Secondary Side Bar chat tab needs ≥ 1.106)
2. Grok Build CLI (grok) on your PATH, or set grok.binaryPath to the absolute path
3. Auth: CLI login (grok login / ~/.grok) or Grok Build: Set API Key / Login in the extension

The VSIX does not bundle the grok binary. Install the CLI first on the machine that runs the extension host (local, or the remote side of SSH/WSL).

From VSIX (sideload)

# In this repo
cd grok-vscode-extension
yarn install
yarn package   # → grok-build-community-edition-0.3.1.vsix

Then in VS Code: Extensions → ⋯ → Install from VSIX… and pick the .vsix.

First run

1. Open a trusted workspace (Workspace Trust is required to start the agent)
2. Open chat: Grok Build: Open Chat (or the activity bar / secondary sidebar icon)
3. If the agent is not running: Grok Build: Start Agent
4. Type a prompt and Send (active file / selection attach by default)

Remote-SSH / WSL

The extension host runs on the remote. Install grok on the remote, not only on your local Mac/PC. Set grok.binaryPath to the remote path if needed.

Troubleshooting

Develop

cd grok-vscode-extension
yarn install
yarn build
yarn typecheck
yarn test

Headless L0 smoke (no VS Code)

yarn smoke:cli   # requires `grok` on PATH

Extension Development Host

1. Open this folder in VS Code / Cursor
2. Press F5 (Run Extension)
3. Activity Bar (left) and/or Secondary Side Bar (right, VS Code ≥ 1.106)
4. Send a prompt

Full checklist: docs/L0-manual-test.md

Package / publish

yarn package          # local .vsix (grok-build-community-edition-<version>.vsix)
# yarn publish:ovsx   # Open VSX first (needs OVSX_PAT)
# yarn publish:vsce   # VS Code Marketplace (needs VSCE_PAT / vsce login)

Automated release (release-please):

Flow on every push to main (workflow Release Please):

1. Opens/updates a Release PR (version bump + CHANGELOG.md) from conventional commits
2. You merge that PR
3. release-please creates tag vX.Y.Z + GitHub Release
4. Same workflow’s Publish job packages the VSIX, attaches it to the release, and (if secrets are set) publishes to:
   1. Open VSX (ovsx) — first
   2. VS Code Marketplace (vsce)

Use commit prefixes: feat:, fix:, feat!: / BREAKING CHANGE:.
chore: / ci: alone usually do not open a version bump.

Secrets (repo → Settings → Secrets → Actions):

Commands

Slash commands (chat composer)

Type / in the chat (same names as Grok Build TUI):

Settings

Layout

src/
  extension.ts
  agent/          # process, ACP, host FS, permissions
  ui/             # chat webview + status bar
  auth/           # SecretStorage API key
  context/        # active file / selection → ACP blocks
  config/         # settings + alwaysApprove guard
  log/output.ts
media/demo.gif              # README product demo
media/grok.svg              # activity bar (monochrome Grok mark)
media/grok-light.svg        # panel tab icon (light theme)
media/grok-dark.svg         # panel tab icon (dark theme)
media/icon.png              # marketplace icon (256×256 from media/icon.svg)
media/icon.svg              # source for marketplace logo
media/tabler/               # webfont copied on build
scripts/smoke-cli.mjs
docs/

Chat UI uses @tabler/icons-webfont (yarn build copies CSS/fonts into media/tabler/).

Documentation

Start here: docs/README.md (design docs in the repo; not shipped inside the VSIX).

License

MIT — see LICENSE.