Skip to content

Latest commit

 

History

History

installation

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
DEVELOPERS.md
DEVELOPERS.md
 
 
NATIVE_INSTALLERS.md
NATIVE_INSTALLERS.md
 
 
QUICK_REFERENCE.md
QUICK_REFERENCE.md
 
 
README.md
README.md
 
 

README.md

Installation Guide

VT Code supports multiple installation methods. Choose the one that works best for you.

Quick Install

macOS & Linux

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

Windows (PowerShell)

irm https://raw.githubusercontent.com/vinhnx/vtcode/main/scripts/install.ps1 | iex

Homebrew (macOS & Linux)

brew install vinhnx/tap/vtcode

Cargo (Rust)

cargo install vtcode

npm (Node.js)

npm install -g @vinhnx/vtcode --registry=https://npm.pkg.github.com

Installation Methods

Method Platforms Command Notes
Native Installer macOS, Linux, WSL See Quick Install above Recommended, auto-detects platform
Homebrew macOS, Linux brew install vinhnx/tap/vtcode Package manager, easy updates
Cargo All cargo install vtcode Build from source, latest dev version
npm All npm install -g @vinhnx/vtcode --registry=https://npm.pkg.github.com JavaScript package manager
npx All npx @vinhnx/vtcode No installation, run directly

After Installation

1. Verify it works

vtcode --version

2. Set your API key

export OPENAI_API_KEY="sk-..."

3. Launch VT Code

vtcode

Supported AI Providers

  • OpenAI (OPENAI_API_KEY)
  • Anthropic (ANTHROPIC_API_KEY)
  • Google Gemini (GEMINI_API_KEY)
  • xAI (XAI_API_KEY)
  • DeepSeek (DEEPSEEK_API_KEY)
  • OpenRouter (OPENROUTER_API_KEY)
  • Ollama (local, no API key)
  • LM Studio (local, no API key by default)

Set the corresponding environment variable for your chosen provider.

Troubleshooting

Command not found after installation

macOS/Linux:

# Refresh your shell
source ~/.bashrc    # bash
source ~/.zshrc     # zsh

Windows: Restart PowerShell or Command Prompt.

Installation fails with "No such file or directory"

This typically indicates a network or CDN caching issue. Try one of:

# Force fresh download
curl -fsSL https://raw.githubusercontent.com/vinhnx/vtcode/main/scripts/install.sh | bash

# Or use GitHub API (always fresh)
curl -fsSL "https://api.github.com/repos/vinhnx/vtcode/contents/scripts/install.sh?ref=main" | jq -r '.content' | base64 -d | bash

Permission denied

macOS/Linux:

chmod +x /usr/local/bin/vtcode

Windows: Run PowerShell as Administrator.

Download failed

  1. Check internet connection: curl https://api.github.com
  2. Verify GitHub is accessible
  3. Try again in a fresh terminal
  4. Check GitHub status

Still stuck?

Uninstall

Native Installer (Shell)

rm /usr/local/bin/vtcode
# or
rm ~/.local/bin/vtcode

Homebrew

brew uninstall vtcode

Cargo

cargo uninstall vtcode

npm

npm uninstall -g @vinhnx/vtcode

Windows (PowerShell)

Remove-Item "$env:LOCALAPPDATA\VT Code\vtcode.exe"
# or (if in Program Files)
Remove-Item "C:\Program Files\VT Code\vtcode.exe"

Installation Paths

macOS & Linux

  • /usr/local/bin/vtcode (standard)
  • /opt/local/bin/vtcode (Homebrew ARM64)
  • ~/.local/bin/vtcode (user fallback)

Windows

  • C:\Program Files\VT Code\vtcode.exe (system-wide, requires admin)
  • %LOCALAPPDATA%\VT Code\vtcode.exe (user-scoped)

The native installers automatically select the best location and add it to PATH.

Additional Resources