Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Quick start
Set a provider key and launch VT Code in a project:
Common commands:
Features
| Area | What VT Code provides |
|---|---|
| Agent runtime | Interactive TUI, slash commands, streaming responses, non-interactive ask and exec, resume and continue, dynamic context curation |
| Coding tools | Safe file operations, patching, ripgrep search, fuzzy file discovery, syntax-aware code intelligence, project indexing, terminal execution |
| Model providers | GitHub Copilot, OpenAI, Anthropic, Gemini, DeepSeek, OpenRouter, Z.AI, Moonshot AI, MiniMax, Xiaomi MiMo, HuggingFace, Ollama, LM Studio, llama.cpp, custom OpenAI-compatible APIs |
| Extensibility | Agent Skills, MCP clients and server mode, lifecycle hooks, subagents, background subprocess agents, custom providers, editor integrations |
| Interoperability | Open Responses, Agent2Agent, Anthropic Messages API compatibility, ATIF trajectory export |
| Terminal UX | Rich TUI, mouse support, text selection, live command output, Ghostty VT snapshots with legacy_vt100 fallback |
Installation
macOS and Linux
|
Skip optional search tools:
|
Windows PowerShell
irm https://raw.githubusercontent.com/vinhnx/vtcode/main/scripts/install.ps1 | iex
[!NOTE] Windows release artifacts are best-effort and may lag behind macOS/Linux builds.
Package managers
# Development tap
[!TIP] Official macOS/Linux release archives include
ghostty-vt/runtime libraries for richer PTY snapshots. Custom installs continue to work with the built-inlegacy_vt100backend.
More details: Installation Guide, Native Installer Guide, Ghostty VT Packaging.
Providers
VT Code supports 20 LLM providers out of the box — from cloud APIs to local inference servers — plus any OpenAI-compatible API through [[custom_providers]].
| Provider | Provider ID | Type |
|---|---|---|
| OpenAI | openai |
Cloud |
| Anthropic | anthropic |
Cloud |
| Gemini | gemini |
Cloud |
| DeepSeek | deepseek |
Cloud |
| GitHub Copilot | copilot |
Cloud |
| OpenRouter | openrouter |
Cloud |
| Xiaomi MiMo | mimo |
Cloud |
| Hugging Face | huggingface |
Cloud |
| Z.AI | zai |
Cloud |
| Moonshot | moonshot |
Cloud |
| MiniMax | minimax |
Cloud |
| Mistral | mistral |
Cloud |
| Qwen | qwen |
Cloud |
| StepFun | stepfun |
Cloud |
| Poolside | poolside |
Cloud |
| OpenCode Zen | opencode-zen |
Cloud |
| OpenCode Go | opencode-go |
Cloud |
| Ollama | ollama |
Local |
| LM Studio | lmstudio |
Local |
| llama.cpp | llamacpp |
Local |
| Custom API | [[custom_providers]] |
Any OpenAI-compatible |
For detailed setup guides, see Provider Guides.
Provider spotlight: Xiaomi MiMo V2.5 Series
VT Code is happy to be part of the Xiaomi MiMo Orbit Program
Xiaomi's MiMo V2.5 Pro is the default model in VT Code — available as the native MiMo provider and through OpenRouter. It delivers strong performance in agentic capabilities, complex software engineering, and long-horizon tasks with a 1M context window and deep reasoning.
| Provider | Model ID | Context |
|---|---|---|
| OpenRouter | xiaomi/mimo-v2.5-pro |
1M tokens |
| OpenRouter | xiaomi/mimo-v2.5 |
1M tokens |
| Xiaomi MiMo | mimo-v2.5-pro |
1M tokens |
| Xiaomi MiMo | mimo-v2.5 |
1M tokens |
Pricing: Pay-as-you-go · Subscription · Quick Access
Read: Xiaomi MiMo documentation | OpenRouter models.
Atlas Cloud
Atlas Cloud is an LLM provider accessible through VT Code's [[custom_providers]] support — no dedicated runtime provider needed.
[]
= "atlascloud"
= "deepseek-ai/DeepSeek-V3-0324"
[[]]
= "atlascloud"
= "Atlas Cloud"
= "https://api.atlascloud.ai/v1"
= "ATLASCLOUD_API_KEY"
= "deepseek-ai/DeepSeek-V3-0324"
Other custom OpenAI-compatible providers use the same [[custom_providers]] pattern.
Recommended validated Atlas chat model pool examples for default_model or
vtcode ask --model <model-id> include:
deepseek-ai/DeepSeek-V3-0324deepseek-ai/deepseek-r1-0528moonshotai/Kimi-K2-InstructQwen/Qwen3-Codergoogle/gemini-2.5-flashopenai/gpt-5.2-chatanthropic/claude-opus-4.5-20251101zai-org/glm-4.7minimaxai/minimax-m2.1xai/grok-4-0709
Configuration
VT Code reads configuration from vtcode.toml in your project root. The default agent uses the MiMo provider with mimo-v2.5-pro as the default model.
[]
= "openai"
= "gpt-5.4"
Useful configuration docs:
Extension points
Skills
VT Code discovers repository, user, admin, and bundled system skills using the open Agent Skills SKILL.md format.
Read: Agent Skills Guide.
MCP
VT Code ships as both an MCP client and server:
- Client: connect to any MCP server for tools like Figma, Playwright, Sentry, and more.
- Server: expose VT Code tools to external agents and editors.
Read: MCP Integration.
Agents and editors
- Zed: native ACP support with project-wide indexing.
- VS Code / Copilot: use the
vtcode askCLI or background agent mode. - Claude Code: VT Code can operate as a subagent under
claude.
Read: Zed ACP Guide, VS Code Guide, Claude Code Guide.
Safety model
VT Code runs a read-restricted shell. Every command passes through a sandbox that can block dangerous operations, log activity, and enforce policy.
| Layer | Behavior |
|---|---|
| Shell sandbox | Restricts commands to a safe subset; dangerous patterns are blocked |
| Tool guardrails | File operations are scoped to the project directory |
| Subprocess isolation | Background agents run in bounded, supervised subprocesses |
| Audit logging | All tool calls are logged for review |
Read: Safety Architecture, Security Hardening, Threat Model.
Protocols and exports
| Protocol | Purpose | Docs |
|---|---|---|
| Open Responses | OpenAI-compatible response format | Open Responses |
| ATIF | Standardized session trajectory export | ATIF Trajectory Format |
| A2A | Agent discovery, task lifecycle, streaming, JSON-RPC | A2A Protocol |
| Anthropic Messages API | Compatibility server for Anthropic-style clients | Provider Guides |
Benchmarks
VT Code has a pending submission to vercel/next-evals-oss, the benchmark behind the Next.js AI Agent Evaluations leaderboard.
| Agent | Model | Status | Success Rate | Passed | Avg Duration |
|---|---|---|---|---|---|
| VT Code | MiMo V2.5 Pro | Pending | -- | -- | -- |
| Claude Code | Claude Sonnet 4 | Published | 72.7% | 24/33 | 173s |
| Codex CLI | o3 | Published | 66.7% | 22/33 | 234s |
| Copilot | Claude Sonnet 4 | Published | 63.6% | 21/33 | 244s |
| Gemini CLI | Gemini 3 Flash | Published | 51.5% | 17/33 | 173s |
| OpenAI Codex | o3 | Published | 48.5% | 16/33 | 221s |
| Aider | Gemini 3 Pro | Published | 45.5% | 15/33 | 228s |
Development
VT Code uses Rust stable, edition 2024, and MSRV 1.88. The dev profile disables incremental compilation (sccache). Set CARGO_INCREMENTAL=1 to override.
Local checks:
Running tests:
Launching VT Code:
Both auto-bootstrap the Ghostty VT runtime. Without it, PTY snapshots fall back to legacy_vt100.
Read: Development Setup, Testing, CI/CD.
Contributing
Contributions are welcome -- typos, docs, bugs, code, ideas. Start with open issues or good first issues. For AI agents, read AGENTS.md first. Humans should also read CONTRIBUTING.md.
Support
VT Code is built in my spare time and shared freely with the community. If it helps you ship code, learn, experiment with agents, or save a few hours, a small donation helps me keep improving it.
You can support ongoing development at buymeacoffee.com/vinhnx. Stars, issues, feedback, and word of mouth also mean a lot.
Star History
If you find VT Code useful, please consider starring the repository. It helps more developers discover the project and gives the community a visible signal that the work is valuable.
License
This repository is licensed under the MIT License.