VT代码

Installation

Native Installer (Recommended) - No dependencies, instant setup: The default macOS/Linux installer also attempts the recommended ripgrep + ast-grep bundle for enhanced semantic grep and programming language-level understanding (optional).

[!TIP] Official macOS/Linux release archives bundle ghostty-vt/ runtime libraries for richer PTY screen snapshots. VT Code still falls back to the built-in legacy_vt100 backend when those assets are unavailable in non-release or custom installs.

macOS & Linux:

```bash curl -fsSL https://raw.githubusercontent.com/vinhnx/vtcode/main/scripts/install.sh | bash

Or skip ripgrep + ast-grep during install

curl -fsSL https://raw.githubusercontent.com/vinhnx/vtcode/main/scripts/install.sh | bash -s -- --without-search-tools

**Windows (PowerShell):**

> [!NOTE]
> Windows installs are currently best-effort and may lag behind macOS/Linux release builds. The current release pipeline is still being tuned for `cross`-based Windows builds, and Windows build minutes can be costly, so Windows artifacts may not be available in every release.

**Alternative Installation Methods:**

If switching between taps, uninstall first:

brew uninstall vtcode brew install vtcode # or: brew install vinhnx/tap/vtcode

Optional: install the search tools bundle later

vtcode dependencies install search-tools ```

Ghostty VT is not installed through vtcode dependencies install .... Instead, VT Code uses runtime libraries that are either:

• Bundled in official macOS/Linux release archives under ghostty-vt/
• Copied by the native installers during release installs
• Staged locally for development with scripts/setup-ghostty-vt-dev.sh
• Auto-bootstrapped by ./scripts/run.sh and ./scripts/run-debug.sh when the runtime libraries are missing

See Installation Guide, Development Setup, and Ghostty VT Packaging.

Note: If you encounter "installed from different tap" errors, uninstall the existing formula first: brew uninstall vtcode, then install from your preferred tap.

See Installation Guide and Native Installer Guide for more options and troubleshooting.

Install GitHub Copilot CLI

brew install gh-copilot

Usage

```bash

Docs & Examples

• Installation
• Native Installers
• Quick Reference
• Getting started
• Interactive mode
• Command line interface
• Subagents
• OAuth Authentication - Secure OAuth 2.0 flows with PKCE, token storage, and automatic refresh
• Configuration
• Update System - Release channels, version pinning, and update management
• AI Provider Setup - Complete guides for configuring different LLM providers:
• OpenAI, Anthropic, Google Gemini
• Atlas Cloud
• OpenRouter
• Ollama
• LM Studio
• llama.cpp
• Context Engineering
• Token budget management
• Dynamic context curation
• Agent Skills - Comprehensive skills location system with multi-location support, precedence handling, and the open Agent Skills standard.
• Standard Compliance - How VT Code implements the Agent Skills standard
• Code Intelligence
• Agent Client Protocol (ACP)
• Zed Integration - Agent Client Protocol Integration. VT Code is fully capable ACP agent, works with ACP Clients, for example Zed.
• Lifecycle Hooks - Execute shell commands in response to agent events, enabling context enrichment, policy enforcement, and automation
• Keyboard Shortcuts
• macOS Alt Shortcut Troubleshooting - Solutions for when Alt/Option shortcuts don't work on macOS
• Exec Mode
• Development
• Development Setup
• Testing
• CI/CD
• Empirical Evaluation - Formal framework for measuring LLM performance across safety, logic, and coding benchmarks.
• FAQ - Frequently asked questions about VT Code
• TUI & Async Guides
• Event Handling - Terminal event architecture and patterns
• Async Architecture - Tokio async/await design and best practices
• Rendering Best Practices - Widget rendering and display optimization
• Ratatui Integration - Complete integration of Ratatui FAQ best practices
• Summary - Overview of all improvements
• FAQ Integration - Mapping of FAQ topics to code
• Async Improvements - Tokio best practices applied
• Architecture
• Security
• Security Model
• Security Documentation Index
• Tool Policies
• Anthropic API Compatibility - Documentation for Anthropic Messages API compatibility server
• ATIF Trajectory Format - Standardized agent trajectory export for debugging, SFT, and RL pipelines

---

Configuration

VT Code supports a rich set of configuration options, with preferences stored in vtcode.toml. Key configuration features include:

• OAuth Settings: Control authentication method and token storage per provider
• Lifecycle Hooks: Execute shell commands in response to agent events - see Lifecycle Hooks Guide
• Tool Policies: Control which tools are allowed, prompted, or denied
• Security Settings: Configure human-in-the-loop approval and workspace boundaries
• Performance Tuning: Adjust context limits, timeouts, and caching behavior
• PTY Backend Selection: Ghostty VT is the default backend; it falls back to legacy_vt100 when runtime libraries are unavailable

For full configuration options, see Configuration.

For Ghostty VT runtime library packaging details, see Ghostty VT Packaging.

Set your API key

export OPENAI_API_KEY="sk-..."

CLI Design Principles

VT Code follows the Command Line Interface Guidelines and standard UNIX principles to ensure a robust and pipe-friendly experience:

- Output Streams: Primary output (e.g., code from ask, events from exec) is sent to stdout. All logs, metadata, reasoning traces, and interaction prompts are sent to stderr. This allows you to safely pipe vtcode output to other tools.

    # Only the generated code is saved to file; metadata remains on screen
    vtcode ask "factorial function in rust" > factorial.rs
    

---

Cargo (Rust package manager)

cargo install vtcode

Visual Studio Code Extension

VT Code is available as an VS Code extension.

<a href="https://marketplace.visualstudio.com/items?itemName=nguyenxuanvinh.vtcode-companion" target="_blank"> <img src="https://custom-icon-badges.demolab.com/badge/Visual%20Studio%20Code-0078d7.svg?style=for-the-badge&logo=vsc&logoColor=white&label=Install" alt="VS Code Extension"/> </a>

The original VT Code extension for Visual Studio Code with full semantic code understanding and AI assistance.

VT Code is also compatible with other VS Code-compatible editors:

<a href="https://open-vsx.org/extension/nguyenxuanvinh/vtcode-companion" target="_blank"> <img src="https://img.shields.io/badge/Available%20on-Open%20VSX-4CAF50?style=for-the-badge&logo=opensearch&logoColor=white" alt="Open VSX Registry"/> </a>

Compatible with Cursor, Windsurf, and other VS Code-compatible editors through the Open VSX registry.

For installation instructions and download links for other IDEs, visit our IDE Downloads page. For troubleshooting, see the IDE Integration Troubleshooting Guide.

---