Documentation

Run VectisCode locally.

The alpha is distributed from source. These are the few steps from checkout to a first Studio session.

01

Install

Use Node 20 or newer. The npm package is not published yet, so build the CLI from this repository:

git clone https://github.com/vectiscode/vectiscode-cli.git && cd vectiscode-cli && npm install

Then run npm run build:cli and node apps/cli/dist/index.js doctor. The interactive TUI starts with node apps/cli/dist/index.js.

02

Provider

Run node apps/cli/dist/index.js providers login anthropic or choose another supported provider. Keys are stored in the operating system keychain. Ollama requires no key.

03

Studio MCP

Enable the official Studio MCP server in Roblox Studio, open your place, then run /connect in the TUI. Use /mcp to inspect the tools and their risk levels.

04

Permissions

plan is read-only. supervised asks before writes. auto permits safe workspace writes. Destructive actions still require explicit approval.

05

Commands

Use run "prompt" for headless JSONL or text output. In the TUI, /sessions resumes a session, /compact summarizes older events, and /undo//redo manage file checkpoints.

06

Privacy

Provider keys are kept in your OS keychain. Prompts and context go directly to the configured provider. The optional website account is not in the CLI execution path.