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.
Table of contents
- Table of contents
- What is VT Code?
- Core capabilities
- Install
- Quick start
- Configuration
- Extension points
- Safety model
- Protocols and exports
- Benchmarks
- Documentation
- Development
- Contributing
- Support
- Star History
- License
What is VT Code?
VT Code is an open-source coding agent for the terminal. It combines a model-driven reasoning loop with a local harness that can read files, search code, edit safely, run commands, preserve context, resume sessions, and connect to external tools.
The default workflow is intentionally simple: one reliable agent loop, explicit delegation for bounded side work, and a workspace-first security model.
Core capabilities
| 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, 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 |
Install
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.
Quick start
Set a provider key and launch VT Code in a project:
Common commands:
VT Code keeps primary output on stdout and sends logs, metadata, reasoning traces, and prompts to stderr. This keeps ask and exec useful in shell pipelines.
Configuration
Most settings live in vtcode.toml. Runtime overrides use --config key=value.
[]
= "openai"
= "gpt-5.4"
Atlas Cloud
Atlas Cloud is a new LLM provider in VT Code. It works through VT Code's [[custom_providers]] support, so you can point VT Code at https://api.atlascloud.ai/v1 without adding a dedicated runtime provider.
[]
= "atlascloud"
= "deepseek-ai/deepseek-v4-flash"
[[]]
= "atlascloud"
= "Atlas Cloud"
= "https://api.atlascloud.ai/v1"
= "ATLASCLOUD_API_KEY"
= "deepseek-ai/deepseek-v4-flash"
Other custom OpenAI-compatible providers use the same [[custom_providers]] pattern.
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 can connect to external MCP servers over stdio or HTTP transports. It can also expose curated tools through its embedded MCP server. The MCP config covers providers, concurrency, timeouts, allowlists, UI rendering, auth, rate limits, and validation.
Read: MCP Integration Guide.
Agents and editors
Safety model
VT Code uses layered controls for shell and filesystem access:
- Command allowlist
- Per-command argument validation
- Workspace path normalization and symlink checks
- Dangerous command blocking
- Optional sandbox integration
- Human approval gates
- Auditable execution logs
The model is designed to reduce prompt injection, argument injection, workspace escape, and privilege escalation risk while keeping developer workflows practical.
Protocols and exports
| Protocol or format | What it enables | Docs |
|---|---|---|
| Open Responses | Vendor-neutral response and item lifecycle model | 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 | moonshotai/Kimi-K2.6:novita |
Pending | 33% | 8/24 | 90.5s |
Read: benchmark notes, eval framework.
Documentation
Start here:
- Documentation Hub
- Documentation Map
- Getting Started
- Interactive Mode
- Commands
- Exec Mode
- Context Engineering
- Architecture
- Development
- FAQ
Ask docs assistants: Google Gemini CodeWiki or Devin DeepWiki.
Development
Useful checks:
VT Code uses Rust stable, edition 2024, and MSRV 1.88.
Read: Development Setup, Testing, CI/CD.
Contributing
VT Code is an open-source project, and I would love for more people to help shape it. Whether you are fixing a typo, improving docs, reporting a bug, testing a model provider, sharing an idea, or sending code, your contribution is welcome.
If you are new here, start with open issues or good first issues. For larger changes, please read CONTRIBUTING.md and AGENTS.md first so we can keep the project easy to review and maintain together.
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.