Grok Build Launcher
Grok Build Launcher is an unofficial VS Code extension that launches Grok Build CLI in a new side terminal directly from the editor toolbar.
Works on Windows, macOS, and Linux.
Current documented release: 0.1.0. See CHANGELOG.md for release-by-release changes.
Repository: https://github.com/TheStreamCode/grok-build-launcher
Independent project disclaimer
This extension is an independent, unofficial project. It is not affiliated with, endorsed by, sponsored by, or approved by xAI. Grok, Grok Build, xAI, and related names, logos, and trademarks are property of their respective owners. This project does not include official xAI or Grok logos.
Features
- Adds a launcher button to the editor title toolbar
- Opens a fresh side terminal beside the active editor on every launch
- Uses the active editor workspace when available, with a fallback to the first open workspace folder
- Runs the configurable Grok Build CLI command, defaulting to
grok
- Offers consent-based guided installation when the default
grok command is missing
- Adds the expected Grok binary directory to PATH during guided install where supported
- Falls back to the absolute installed
grok executable path after guided install when enabled
- Supports quoted Windows executable paths
- Does not collect telemetry, analytics, or personal data
Requirements
- VS Code
^1.120.0
- Grok Build CLI available in the integrated terminal environment, or guided installation enabled
- On Windows guided installation requires Git Bash from Git for Windows, because the official xAI installer is a Bash script
Installation
- Install the extension from the VS Code Marketplace or from a local
.vsix package.
- Open a workspace or file in VS Code.
- Click the Grok Build Launcher button in the editor title toolbar.
If Grok Build CLI is already installed and grok is on PATH, the launcher starts immediately.
Manual Grok Build CLI installation uses the official xAI installer:
curl -fsSL https://x.ai/cli/install.sh | bash
Guided Installation
When the launcher runs the default grok command and the integrated terminal reports that it is missing, the extension asks for explicit confirmation before installing anything.
If you choose Install, the extension opens a visible install terminal and runs a generated local Node script. That script invokes the official xAI installer and then configures the expected PATH location.
Platform behavior:
- Windows: runs the official installer through Git Bash and adds
%USERPROFILE%\.grok\bin to the Windows user PATH using the Windows user environment API.
- macOS: runs the official installer through the active shell and ensures
$HOME/.grok/bin is present in the relevant shell startup files, including .zshrc and .zprofile for zsh.
- Linux: runs the official installer through the active shell and ensures
$HOME/.grok/bin is present in the relevant shell startup file, such as .bashrc, .zshrc, .profile, or fish config.
After a successful guided install, the extension can update grokBuildLauncher.cliCommand to the detected absolute executable path. This makes the launcher work even before VS Code is restarted and before new terminals inherit the updated PATH.
The guided install flow is enabled by default, but it never runs without explicit confirmation.
How It Works
Each launch creates a new terminal beside the current editor and sends the configured command immediately. Existing terminals are not reused.
When possible, the launcher opens the terminal in the workspace folder of the active editor. If the active editor is outside the workspace, it falls back to the first workspace folder in the current VS Code window.
The launcher checks command availability through VS Code terminal shell integration, so detection follows the same environment used by the integrated terminal rather than the extension host process.
For safety, the launcher is disabled in untrusted workspaces. The executable command is treated as machine-level user configuration and workspace-controlled command values are ignored, preventing a repository from changing the command that runs when you click the toolbar button.
Configuration
| Setting |
Default |
Description |
grokBuildLauncher.cliCommand |
grok |
Command executed when the launcher button is clicked. |
grokBuildLauncher.terminalName |
Grok Build |
Base label used for created launch terminals. |
grokBuildLauncher.autoInstall |
true |
Offer guided installation when the default grok command is missing. Installation still requires explicit confirmation. |
grokBuildLauncher.preferAbsoluteInstalledPath |
true |
After guided install, update the launch command to the detected absolute grok executable path. |
grokBuildLauncher.cliCommand, grokBuildLauncher.autoInstall, and grokBuildLauncher.preferAbsoluteInstalledPath are machine-level settings. Configure them from your user or remote machine settings, not from repository workspace settings.
Use the Command Palette to open the extension settings:
Grok Build Launcher: Open Settings
Examples:
Default command:
"grokBuildLauncher.cliCommand": "grok"
Windows absolute executable path:
"grokBuildLauncher.cliCommand": "\"C:\\Users\\You\\.grok\\bin\\grok.exe\""
macOS or Linux absolute executable path:
"grokBuildLauncher.cliCommand": "\"/Users/you/.grok/bin/grok\""
Disable guided install prompts:
"grokBuildLauncher.autoInstall": false
Troubleshooting
The terminal opens but grok is not recognized
Install Grok Build CLI with the official xAI installer:
curl -fsSL https://x.ai/cli/install.sh | bash
On Windows, install Git for Windows first and make sure Git Bash is available. The guided installer uses Git Bash because the official installer is a Bash script.
If installation succeeds but existing terminals still do not see grok, restart VS Code so new terminal processes inherit the updated PATH.
Windows PATH was updated but PowerShell still cannot find grok
Confirm that %USERPROFILE%\.grok\bin is present in your user PATH. Restart VS Code and open a new terminal. Existing terminal sessions do not automatically reload Windows user environment changes.
Check grokBuildLauncher.cliCommand and verify that the same command works in a regular integrated terminal.
Custom executable path on Windows
Quote executable paths that contain spaces. This is required for paths such as "C:\Program Files\Grok Build\grok.exe".
Multi-root workspaces
The launcher prefers the workspace folder of the active editor. To control where Grok Build starts in a multi-root window, open a file from the target workspace before clicking the toolbar button.
Privacy
Grok Build Launcher does not collect telemetry, analytics, or personal data.
The extension launches commands in your local VS Code integrated terminal. Grok Build CLI itself is a separate product with its own behavior, authentication, network access, and terms.
Legal And Trademarks
This repository contains only the extension code and original launcher assets. It does not include official xAI or Grok logos.
See TRADEMARKS.md for the full affiliation and trademark notice.
Development
Local verification and packaging:
npm install
npm run check
npm run test:integration
npm run package
npm run package creates the .vsix file in the workspace root.
The repository includes unit tests, metadata checks, VS Code integration smoke tests, and CI coverage for Windows and Linux.
Support
Open a GitHub issue for bugs and feature requests. For support details, see SUPPORT.md.
License
Released under the MIT License. See LICENSE for details.