Skip to content

Getting Started with Victor

Welcome to Victor! This guide will help you install, configure, and run Victor in under 5 minutes.

What is Victor?

Victor is an open-source agentic AI framework that supports 24 LLM providers (both local and cloud) through a unified CLI/TUI interface.

Key Features:
- 24 LLM Providers: Cloud (Anthropic, OpenAI, Google, Vertex) and local (Ollama, LM Studio, vLLM)
- Provider Switching: Switch between any provider mid-conversation without losing context
- No API Key Required: Use local models by default for privacy and cost savings
- 34 Tool Modules: File operations, code editing, git, testing, search, and more
- 9 Domain Verticals: Coding, DevOps, RAG, Data Analysis, Research, Security, IaC, Classification, Benchmark
- YAML Workflows: Define multi-step automation with scheduling and versioning
- Multi-Agent Teams: Coordinate specialized AI agents for complex tasks

Choose Your Path

Select the guide that matches your situation:

Your Goal Guide Time
Quick start Quickstart 5 min
First agent from Python Your First Agent 5 min
Full installation options Installation 10 min
Configure Victor Configuration 10 min
Troubleshoot issues Troubleshooting As needed

Fastest Path to Running Victor

Local Model (No API Key)

# 1. Install Victor
pipx install victor-ai

# 2. Install and start Ollama
brew install ollama  # macOS
# or: curl -fsSL https://ollama.com/install.sh | sh  # Linux
ollama serve

# 3. Pull a model
ollama pull qwen2.5-coder:7b

# 4. Start Victor
victor chat "Hello, Victor!"

Cloud Provider (API Key Required)

# 1. Install Victor
pipx install victor-ai

# 2. Set API key
export ANTHROPIC_API_KEY=sk-ant-your-key

# 3. Start Victor
victor chat --provider anthropic "Hello, Victor!"

Docker

# Pull and run
docker pull ghcr.io/vjsingh1984/victor:latest
docker run -it \
  -v ~/.victor:/root/.victor \
  -v "$(pwd)":/workspace \
  -w /workspace \
  ghcr.io/vjsingh1984/victor:latest chat

System Requirements

Requirement Minimum Recommended
Python 3.10 3.11+
RAM 4 GB 8 GB+
Disk 500 MB 1 GB (local models: 8-32 GB)
OS Linux, macOS, Windows (WSL2) Linux or macOS

Quick Verification

After installation, verify Victor is working:

# Check version
victor --version

# List providers
victor providers

# Test chat
victor chat "Hello, Victor!"

# Open TUI mode
victor

Getting Started Guides

1. Installation Guide

Complete installation instructions including:
- System requirements
- Installation methods (pipx, pip, Docker, development)
- Optional dependencies
- Platform-specific instructions (macOS, Linux, Windows)
- Troubleshooting common issues

2. Quickstart Guide

Get productive quickly:
- First run experience
- Interface modes (TUI, CLI, API)
- Essential commands
- Common workflows
- Quick reference card

3. Configuration Guide

Customize Victor for your needs:
- Environment variables and API keys
- Profiles configuration
- Global settings
- Project context files (.victor.md, CLAUDE.md)
- Modes (BUILD, PLAN, EXPLORE)

What's Next?

After getting started:

  1. User Guide - Daily usage patterns and workflows
  2. Provider Reference - All 24 providers detailed
  3. Tool Catalog - 34 tool modules
  4. Workflow DSL - YAML workflow automation

Need Help?

Next: Installation Guide | Quickstart | Configuration