VTCode README

README проекта с github.com/vinhnx/VTCode. Одним файлом markdown: README.md.

VT Code

Terminal-first coding agent, desktop-ready on macOS — explore, plan, edit, and verify with your model of choice.

Rust License GitHub release

Ask DeepWiki macOS 15+ arm64 and x64

VT Code Desktop app demo Desktop app

VT Code terminal TUI demo
Terminal TUI

Overview

VT Code is an auditable, resumable agentic coding loop — terminal TUI plus native macOS app, open source under MIT OR Apache-2.0 (see Contributing and License). Start with Quick start; the full map is in Documentation.

At a glance What you get
Plan Plan read-only, review turn diffs.
Safety Auditable command policy with sandboxing.
Long runs Headless exec with resume; snapshots, subagents.
Extend MCP (interop), skills, plugins.
Models Hosted or local providers per task.

Quick start

Install on macOS, Linux, or Windows/WSL, configure once, and run. Source builds need Rust 1.100.0+ (edition 2024); the installation guide covers every method.

1. Install

# Review the installer script before running it: https://github.com/vinhnx/vtcode/blob/main/scripts/install.sh
curl -fsSL https://raw.githubusercontent.com/vinhnx/vtcode/main/scripts/install.sh | bash

Same-guide alternatives: brew install vinhnx/tap/vtcode, cargo install vtcode, Windows irm https://raw.githubusercontent.com/vinhnx/vtcode/main/scripts/install.ps1 | iex, or Desktop app. Verify with vtcode --version.

2. Configure your project

From your project directory:

cd path/to/your/project
vtcode init # scaffolds vtcode.toml, .vtcode/, and AGENTS.md; review before committing
vtcode secret add openai # replace `openai` with your provider

Keys stay in secure storage (OS keyring or encrypted file); env vars, workspace .env, or vtcode login work where supported. See getting started and provider guides. ChatGPT: vtcode login openai (or --from-codex); Copilot uses the official copilot CLI — see OAuth authentication.

Caution: Keep API keys out of Git and vtcode.toml, and never commit a workspace .env file.

3. Run your first task

vtcode   # open the interactive TUI

Ask one focused question, review the changes and test results, then commit. See Usage for automation and session commands.

Usage

Common commands (full list in command reference):

Goal Command
Start the TUI vtcode
Ask without tools vtcode ask "explain Rc vs Arc"
Run a task headlessly vtcode exec "refactor main.rs"
Review pending changes vtcode review
Schedule recurring work vtcode schedule create --prompt "..." --every 1h
Resume the last session vtcode continue
Resume a headless run vtcode exec resume --last "prompt"
Roll back a snapshot vtcode snapshots / vtcode revert
Inspect a run log vtcode trajectory

ask is tool-free; exec runs the full tool loop and needs workspace trust (approve the TTY prompt, or set VTCODE_TRUST_WORKSPACE=full-auto for non-TTY runs; deny refuses instead). review inspects uncommitted changes without the agent loop. For larger tasks, start read-only, review the turn diff, and use /explain without another model call. See interactive mode, exec mode, and full automation.

Desktop app

Native macOS app (macOS 15+) sharing the CLI runloop, providers, tool policy, sandboxing, sessions, config, and credentials. Configure a provider first (Quick start).

Install (macOS 15+)

brew install --cask vinhnx/tap/vtcode-desktop

Update cask installs with brew upgrade --cask vinhnx/tap/vtcode-desktop. Without Homebrew, download the latest release or run vtcode desktop --install, then launch with vtcode desktop or from Finder. The cask ships Apple Silicon builds; Intel Macs install from source with vtcode desktop --install (see installation guide).

[!WARNING] First launch needs one-time approval for ad hoc-signed builds (Homebrew cask included): open the app once from Applications, click Open Anyway in System Settings › Privacy & Security, then reopen from Finder (or vtcode desktop). The button expires about an hour after a blocked launch — reopen the app to bring it back. Notarized releases skip this. See desktop workspace.

Documentation

Start from the documentation index or Wiki. The index is canonical; this section keeps one link per task.

Start

Use

Automate

Extend

Develop

Development

26-crate workspace sketch at version 0.183.1 (full list in the architecture guide; default-members builds only the root binary, vtcode-core, vtcode-skills, vtcode-tui-runtime, and vtcode-ui):

graph LR
    BIN["vtcode binary"] --> CORE["vtcode-core harness"]
    CORE --> LLM["vtcode-llm"]
    CORE --> SAFETY["vtcode-safety"]
    CORE --> EVENTS["vtcode-exec-events (crates/common)"]
    CORE --> MEMORY["vtcode-memory"]
    CORE --> SKILLS["vtcode-skills"]
    CORE --> TUI["vtcode-tui-runtime"]
    CORE --> UI["vtcode-ui"]

Build with Rust 1.100.0+ (edition 2024; workspace version 0.183.1):

git clone https://github.com/vinhnx/vtcode.git
cd vtcode
./scripts/run-debug.sh     # build and launch a debug binary
./scripts/check-dev.sh     # fast gate: clippy, fmt, check (add --test for tests)
cargo nextest run          # tests via nextest (see testing guide)

CI uses --locked and RUSTFLAGS="-D warnings"; match locally with RUSTFLAGS="-D warnings" cargo check --locked. See development and testing.

Release binaries and notes live on GitHub releases.

Contributing

VT Code is open source and community-driven. Code, docs, evals, and fixes are welcome — include vtcode trajectory output in bug reports where possible. Before a PR, read contributing and pick a good first issue or help wanted item. Forks: keep license and third-party notices intact (see License).

Security

Report vulnerabilities privately via GitHub private vulnerability reporting. See the security policy.

Community

The Code of Conduct keeps review constructive. Contact: vinhnguyen2308 [at] gmail [dot] com.

Thanks to our contributors

Thank you to everyone below. You are the reason this project keeps moving.

View all contributors (31)

Security Advisors

@glmgbj233  @nnfrog 

Main Contributor

@kernitus 

Core Contributors

@ct-jaryn  @7jrxt42BxFZo4iAnN4CX  @xcrong  @netbrah  @Sachin-Bhat  @gzsombor  @leonj1  @chenrui333  @oiwn 

Contributors

@apewithllm  @pawurb  @f-o-x11  @shouryamaanjain  @rs545837  @georgeatparallel  @S2thend  @vivekgupta-memcode  @ericcurtin  @Sanjays2402  @diegosouzapw  @raphamorim  @TuanLe-bk18  @ForrestThump  @RobertBorg  @EvoLinkAI  @uiYzzi  @poelzi  @morler 

Resources

Support VT Code

Current sponsors: Codemod and CodeRabbit.

@codemod  @coderabbitai 

GitHub Sponsors

If you like VT Code, please star the repo and share it — starring helps discovery and brings in new users, contributors, and sponsors. Thank you for growing the community.

Star History Chart

License

First-party code is MIT OR Apache-2.0, available under either LICENSE-MIT or LICENSE (Apache-2.0). You are welcome to fork, use, copy, modify, merge, publish, distribute, sublicense, and sell copies of the code, for personal or commercial use, under either license. Keep the license and copyright notices when you distribute copies. Third-party code keeps its original licenses, listed in THIRD-PARTY-NOTICES.

VTCode (vinhnx/VTCode)

Ищем в базе…

914 ·GitHub
Что это такое?VT Code — это агент для написания кода с открытым исходным кодом, написанный на Rust. Он работает в терминале и позволяет исследовать, планировать, редактировать и проверять изменения в вашем репозитории с помощью облачных или локальных моделей ИИ.
Это обычный CLI-инструмент или у него есть терминальный интерфейс?И то, и другое: есть команды для скриптов, например 'vtcode ask' и 'vtcode exec' для работы без интерфейса, а также полноценный интерактивный TUI (построен на ratatui/crossterm) для планирования задач и просмотра изменений за каждый шаг диалога.
Как мне установить его и начать пользоваться в своем проекте?Установите через официальный скрипт, Homebrew или Cargo (PowerShell в Windows), выполните 'vtcode --version' для проверки, затем создайте в папке проекта конфигурацию и инструкции для агента и добавьте данные доступа к провайдеру перед запуском 'vtcode'.
Какие провайдеры ИИ я могу использовать и нужен ли мне API-ключ?Работает с облачными провайдерами, например OpenAI, а также с локальными моделями. Учетные данные добавляются через 'vtcode secret add', переменные окружения, файл .env в рабочей папке или 'vtcode login' для провайдеров с поддерживаемым входом.
Версия для Windows так же надежна, как сборки для macOS и Linux?Windows (включая WSL) поддерживается, но сборки для Windows прямо помечены как версии с поддержкой «по мере возможности» и могут отставать от релизов для macOS и Linux.
Как хранятся мои учетные данные провайдера?Данные, добавленные через 'vtcode secret add', попадают в защищенное хранилище: либо в хранилище ключей ОС (keyring), либо в зашифрованный файл. Проект также предупреждает не коммитить API-ключи в Git или в vtcode.toml.
Что такое HOVER-цикл, о котором упоминается в документации?HOVER — это цикл самокоррекции VT Code: агент заранее формулирует ожидаемый результат, собирает ограниченный объем доказательств и меняет подход только тогда, когда доказательства расходятся с этим ожиданием.
С чем, кроме моделей ИИ, может соединяться VT Code?Он интегрируется с серверами MCP, Skills, плагинами и мостами к редакторам через ACP, а также с экспериментальным вспомогательным компонентом WebMCP, расширяя инструменты агента и его возможности в других редакторах.
Может ли он работать без присмотра на долгих или запланированных задачах?Да: 'vtcode exec' выполняет полный цикл инструментов в фоновом режиме со сжатием контекста и сессиями, которые можно возобновить, а 'vtcode schedule create' настраивает повторяющиеся долговременные задачи с промптами. Однако для полной автоматизации нужно явно подтвердить доверие к рабочему пространству.
Можно ли продолжить или ответвить предыдущую сессию?Используйте 'vtcode continue', чтобы продолжить последнюю сессию, 'vtcode continue --session-id', чтобы ответвить более раннюю, и 'vtcode trajectory', чтобы просмотреть журнал выполнения.
Какие есть похожие проекты?Baize, grok-build, goose, lean-ctx, oh-my-pi, kimi-code, Axl, codeAgent
Автор
vinhnx
Размер
179 MB
Звёзды
914
Возраст
1 г
Коммиты · 90 дней