Overview
Vtrix CLI is the official command-line tool for the Vtrix AI platform, covering its core capabilities:
- Model inference: Submit multimodal generation tasks (video / image / audio) directly from the terminal and wait for results in real time.
- Skill management: Search and install Agent Skills from SkillHub, enabling agents like Claude Code and Cursor to call Vtrix model capabilities directly.
Authentication is a prerequisite for both model inference and skill management. Use vtrix auth login for browser-based authorization, or vtrix auth set-key to write an API Key directly. Credentials are stored automatically and reused for all subsequent calls.
Core Capabilities
- Model discovery: Browse models by type or search by keyword with
vtrix models list. - Live parameter specs:
vtrix models specfetches model parameter specs from the server in real time, so agents and developers always have the latest, accurate parameter definitions — no stale docs. - Model inference: Submit generation tasks with
vtrix run, supporting multimodal inputs (text, image, video, audio) with built-in progress tracking and direct result output. - Skill management: Search and install Agent Skills with
vtrix skills, with automatic detection and installation into Claude Code, Cursor, Codex, and other agent environments. - Agent-friendly:
--output jsonfor structured output,--dry-runfor preview mode, and POSIX exit codes — all designed for automated agent workflows.
Installation
# Requires Node.js >= 18
npm install -g @vtrixai/vtrix-cli
# Verify installation
vtrix version # Requires Go >= 1.26
git clone https://github.com/VtrixAI/vtrix-cli.git
cd vtrix-cli && make install
# User-local install (no sudo)
make install PREFIX=$HOME/.local
export PATH="$HOME/.local/bin:$PATH" # Supported platforms
macOS amd64 / arm64 (Apple Silicon)
Linux amd64 / arm64
Windows amd64
# Download the binary for your platform from GitHub Releases
# https://github.com/VtrixAI/vtrix-cli/releases Platform Overview
Access text, image, video, and audio multimodal capabilities from leading providers — all through a single API Key.
| Provider | Representative Models | Capabilities |
|---|---|---|
| Vtrix | Kirin / Spark series | Video / Image / Audio |
| Vidu | Q1 / Q2 / Q3 series | Video |
| Veo 3.1 / Nano Banana | Video / Image | |
| OpenAI | GPT Image 1 / 1.5 | Image |
| Pixverse | V6 series | Video |
| MiniMax / Mureka | Hailuo / Song Generator | Audio |
Coming Soon
More infrastructure on the way
The following features are actively in development and will be rolled out to all users:
- Credits management: Query account credit balance and usage details via CLI, with support for automatic alerts.
- More infrastructure: Billing queries, usage statistics, team collaboration, and more.