Veirox CLI · v0.0.2 · Go · cosign-signed

Veirox CLI
documentation

29 commands, one binary. Drive every Veirox operator workflow from your terminal — bootstrap projects, trigger tasks, stream sessions, approve actions, manage entities.

5-minute quickstart → Command reference

Install in 30 seconds

# macOS / Linux — Homebrew
brew install veirox-cloud/veirox/veirox

# Any Unix — curl | sh
curl -fsSL https://veirox.com/cli/install.sh | bash

# Windows — Scoop
scoop bucket add veirox https://github.com/veirox-cloud/veirox-scoop
scoop install veirox

All install methods see the same binary at veirox-cloud/veirox-dist. See all install methods →

Pick your path

New here? Start with the quickstart. Looking for a specific command? Jump to reference.

Start here

Quickstart

Install → login → first command in 5 minutes.

Setup

Configuration

Profiles, config.toml, env vars, keyring storage.

Help

Troubleshooting

Auth errors, version mismatch, keyring issues.

API

Command reference

Every command, every flag, exit codes, examples.

Concept

Entities

13 kinds — memory, knowledge, skill, runbook, …

Concept

Sessions

How agent runs work — transcripts, costs, cancellation.

Concept

Approvals

Human-in-the-loop gates for destructive actions.

Concept

MCP integration

Wire Veirox into Cursor, Claude Code, Codex as MCP tools.

Cookbook

Recipes

Trigger from CI, approve from terminal, sync runbooks, …

Common commands

A few things you'll do every day.

Authenticate

veirox login           # OAuth device flow
veirox project list

Trigger a task

veirox task list --enabled
veirox task run <task-id> --wait

Watch a live session

veirox tail            # newest sessions
veirox logs <id> --follow

Approve / reject

veirox approval list
veirox approval approve <id>

Manage entities

veirox entity list --kind runbook
veirox entity create --kind memory ...

MCP setup

veirox mcp setup       # Cursor / Claude / Codex
veirox mcp doctor