Documentation

Get up and running

Install VivekMind, plug in your favorite AI provider, and start coding.

Installation

VivekMind CLI requires Node.js 20 or later. We provide quick one-line script installers for all major platforms, or you can install manually via npm.

Quick Installation (macOS / Linux)

bash

curl -fsSL https://vivekmind-assets.oss-cn-hangzhou.aliyuncs.com/installation/install_vivekmind.sh | bash

Quick Installation (Windows)

powershell

powershell -Command "Invoke-WebRequest -Uri 'https://vivekmind-assets.oss-cn-hangzhou.aliyuncs.com/installation/install_vivekmind.bat' -OutFile 'install.bat'; .\install.bat"

Manual Installation (npm)

bash

npm install -g vivekmind

Verify Installation

bash

vivekmind --help

Permission errors?

If you run into permission errors during npm installation, run npm config set prefix ~/.npm-global and add ~/.npm-global/bin to your PATH.

Quick Start

1. Set a provider key

bash

export ANTHROPIC_API_KEY=sk-ant-...
# or
export OPENAI_API_KEY=sk-...
# or
export GEMINI_API_KEY=...

2. Run

bash

vivekmind

3. One-shot mode

bash

vivekmind -p "fix the failing test in src/api/auth.test.ts"

Settings File

VivekMind reads ~/.vivekmind/settings.json on startup.

json

{
  "provider": "bedrock",
  "model": "anthropic.claude-opus-4-v1:0",
  "theme": "tokyo-night",
  "vim": true,
  "memory": { "auto": true, "consolidateEvery": 50 }
}

Environment Variables

bash

ANTHROPIC_API_KEY=...
OPENAI_API_KEY=...
GEMINI_API_KEY=...
AWS_REGION=us-east-1
AWS_ACCESS_KEY_ID=...
AWS_SECRET_ACCESS_KEY=...
OLLAMA_HOST=http://localhost:11434

Project Config

Drop a .vivekmind/ folder at the root of any repo.

shell

.vivekmind/
  config.json     # per-project overrides
  commands/       # *.md → /commands
  memory/         # seeded project knowledge

AWS Bedrock

bash

export AWS_REGION=us-east-1
export AWS_ACCESS_KEY_ID=...
export AWS_SECRET_ACCESS_KEY=...
vivekmind /model anthropic.claude-opus-4-v1:0

IAM

Only needs bedrock:InvokeModel and bedrock:InvokeModelWithResponseStream.

Anthropic

bash

export ANTHROPIC_API_KEY=sk-ant-...
vivekmind /model claude-sonnet-4

OpenAI

bash

export OPENAI_API_KEY=sk-...
vivekmind /model gpt-5

Gemini

bash

export GEMINI_API_KEY=...
vivekmind /model gemini-2.5-pro

Memory

Auto-extracts facts from conversations and consolidates them. Use /memory, /remember, /forget.

Subagents

Spawn focused subagents to tackle parts of a task in parallel.

Skills

Reusable, conditionally-activated knowledge bundles. Drop SKILL.md into .vivekmind/skills/.

MCP

Connect any Model Context Protocol server.

json

{
  "mcpServers": {
    "filesystem": { "command": "npx", "args": ["-y", "@mcp/filesystem"] },
    "postgres": { "command": "npx", "args": ["-y", "@mcp/postgres", "$DATABASE_URL"] }
  }
}

Extensions

Install community extensions via /extensions install.

Headless / CI

bash

vivekmind -p "regenerate openapi.yaml" --json

Arena

Compare models head-to-head on the same prompt.

shell

/arena claude-opus-4 vs gpt-5 vs gemini-2.5-pro

Sandbox

Run shell tools inside Docker or Podman for safer execution.