Quickstart
Installing and running VT Code
Install globally with your preferred package manager. If you use Cargo:
cargo install vtcode
Alternatively, if you use Homebrew:
brew install vinhnx/tap/vtcode
Or if you prefer NPM:
npm install -g vtcode
Then simply run vtcode to get started:
vtcode
Using VT Code with your preferred provider
Set your API key environment variable and run VT Code:
# Set your API key
# Launch VT Code
Available providers
VT Code supports multiple providers including OpenAI, Anthropic, xAI, DeepSeek, Gemini, Z.AI, Moonshot AI, OpenRouter, and Ollama (local).
Set your preferred API key environment variable:
# OpenAI
# Anthropic
# Google Gemini
# xAI
# DeepSeek
# Z.AI
# Moonshot AI
# OpenRouter
Agent Client Protocol (ACP)
VT Code can integrate with code editors like Zed. To configure ACP, refer to the ACP docs.
Configuration
VT Code supports a rich set of configuration options, with preferences stored in vtcode.toml. For full configuration options, see Configuration.
Key Features
- Multi-Provider AI: OpenAI, Anthropic, xAI, DeepSeek, Gemini, Z.AI, Moonshot AI, OpenRouter, Ollama (local)
- Code Intelligence: Tree-sitter parsers for Rust, Python, JavaScript/TypeScript, Go, Java, Swift
- Smart Tools: Built-in code analysis, file operations, terminal commands, and refactoring
- Editor Integration: Native support for Zed IDE via Agent Client Protocol (ACP)
- Security First: Sandboxed execution with configurable safety policies
- Semantic Search: AST-based search capabilities with ast-grep integration
- Context Management: Advanced token budget tracking and context curation
- TUI Interface: Rich terminal user interface with real-time streaming
Docs & Examples
- Getting started
- Context Engineering
- Code Intelligence
- Agent Client Protocol (ACP)
- Zed Integration
- Custom Prompts
- Exec Mode
- Development
- Architecture
- Tool Policies
Support VT Code Development
I build VT Code in my free time as a passion project to research and explore how coding agents work in practice. If you find VT Code useful, please consider supporting my work with a coffee via BuyMeACoffee:
Your support means the world to me, thank you!
License
This repository is licensed under the MIT License.
