Build by Grok Install CLI

Dedicated CLI install surface

Install Build by Grok Install locally. Land in grok>. Link later if you want.

Run the one-line install from the local folder you want the brain tied to. The CLI installs on your machine and drops you straight into grok> in that folder.

The VS Code extension now ships on top of the same local-first CLI path, so the terminal and editor lanes stay aligned.

The public install page keeps the fast path visible. Sign in to the dashboard for the longer CLI guide, BYOK notes, and account-level docs.

Install command copy + run

~/projects $ curl -fsSL https://install.buildbygrok.com/install.sh | bash

Installing the current CLI bundle...

Checking the checksum...

Keeping the install local to this machine...

Then it lands in grok> in the folder you started from.

Quickstart

Fastest clean start

~/projects $ curl -fsSL https://install.buildbygrok.com/install.sh | bash

Run that from the folder you want the local brain tied to.

grok> list all the files in this repo

You are now in the terminal-native agent for that local folder.

grok> /login

Use this later only when you want advanced GitHub-connected features.

grok> /api-key add xai

Optional: store your own xAI key locally for CLI requests.

grok> /api-key test xai

Validate the stored key before you start heavier build or repair work.

~/projects $ sudo apt install git

Install git yourself when you want local /git commands.

~/projects $ cd your-local-folder && git init

~/projects $ git add . && git commit -m "initial commit"

Finish the first local git commit in your normal terminal. If git asks for name or email, finish that setup there first, then come back to Build by Grok.

~/projects $ curl -fsSL https://install.buildbygrok.com/install.sh | bash -s -- --install-only

Use this when you want the local install without launching right away.

~/projects $ grok-build open

Open the signed-in browser surface only when you want advanced account or repo-connect tools.

Happy path: run the one-liner from the working folder and let it drop you into grok>. Link later only when you want advanced GitHub-connected features.

Deeper Setup

Keep the heavy docs in the dashboard

/app/install/index.html

Signed-in CLI guide with BYOK, git notes, and the longer local-first setup path.

/api-key add xai

Store your own xAI key locally when you want the CLI to bill against your account.

git is optional

The CLI starts in the current folder whether git is present or not.

/login

Use the signed-in dashboard for account tools and deeper documentation.

The install page should get you moving fast. The signed-in dashboard now holds the deeper product and setup documentation.

First terminal test

Use these prompts after startup

grok> What files are in this repo and what does it look like this project does?

grok> Review the top 5 security or correctness risks. Do not generate code yet.

grok> Focus on one file, explain the smallest safe fix, then generate only the minimal code change.

grok> /help

grok> /status

grok> /clear

Common gotchas

If the flow seems off

  • The install itself is local. It does not connect GitHub by itself.
  • The default one-line install launches the CLI locally in the current folder. It does not auto-link the account.
  • Run /login from grok> or grok-build login later only when you want advanced GitHub-connected features.
  • Run /api-key add xai if you want the CLI to use your own xAI key locally instead of the platform default.
  • Use /api-key status and /api-key test xai to confirm BYOK is configured correctly.
  • grok-build uses the current local folder as the repo root. Git is not required just to start.
  • If git is missing, install it yourself on the machine, then return to grok> and retry the command.
  • Finish the first local git setup in your normal terminal. If git asks for name or email during that first commit, finish it there before using /git in grok>.
  • Before the first local /git push, make sure one normal terminal push works in that repo, or use the optional connected GitHub lane.
  • grok-build open is the signed-in browser path. grok-build run is the browser-connected runtime for the current local folder.
  • Use grok-build init only when you want the explicit GitHub bootstrap path into an empty folder.
  • If you are at grok:file.tsx> and want the main prompt back, run /clear.
  • When asked [y/N], answer only y or n.