Getting Started

Prerequisites

Ollama (recommended), or API keys for DeepSeek, Qwen, Kimi, or Zhipu — for LLM inference
Rust (if building from source)

Supported Platforms

macOS — full support
Linux — full support

Install Ollama

# macOS / Linux
curl -fsSL https://ollama.com/install.sh | sh

# Pull models for different roles
ollama pull qwen2.5-coder:3b-instruct   # small
ollama pull qwen2.5-coder:7b-instruct   # medium
ollama pull qwen2.5-coder:14b-instruct  # large
ollama pull qwen2.5vl:7b                # vision

Install Vibe Action

Via Cargo (recommended):

cargo install vibe-action

Build from source:

git clone https://github.com/keygenqt/vibe-action.git
cd vibe-action
cargo build --release

First Run

On first run, Vibe Action creates the config and default actions:

$ vibe-action --help

This creates:

~/.vibe-action/config.yaml — configuration
~/.vibe-action/actions/ — built-in actions

Configure Cluster

Edit ~/.vibe-action/config.yaml to point to your Ollama instance:

cluster:
  - provider: ollama
    host: http://localhost:11434
    model: qwen2.5-coder:14b-instruct

Full field reference — roles, timeouts, multi-node clusters — see Configuration.

Run Your First Actions

# AI-powered commit
vibe-action commit

# Translate a file
vibe-action translate README.md

# Describe a screenshot
vibe-action describe screenshot.png

Full list of ready-to-use actions — Built-in Actions. System commands (status, clean, stop) and environment variables — CLI Reference.

Next Steps

YAML Format — learn the action manifest schema
Val Candidates — data binding and guards
Custom Actions — write your own
Query Providers — unified input for CLI and IDE
System Providers — runtime environment tags

Keyboard shortcuts

Vibe Action