@alveare/cli

Command-line interface for the Alveare Private SLM Inference-as-a-Service platform.

Installation

npm install -g @alveare/cli

Or link locally for development:

cd cli
npm install
npm run build
npm link

Quick Start

# Configure your API key
alveare config set api-key alv_live_<your-key-here>

# Run inference
alveare infer -s summarise "Summarise this quarterly earnings report..."

# Interactive chat
alveare chat

# Check available specialists
alveare models

# View usage stats
alveare usage

Commands

alveare config

Manage CLI configuration stored at ~/.alveare/config.json.

alveare config set api-key alv_live_abc123def456...
alveare config set base-url https://api.alveare.ai
alveare config show

alveare infer

Run a single inference request.

alveare infer -s summarise "Your text here..."
alveare infer -s classify -m 32 "Is this spam?"
alveare infer -s code "Write a prime checker in Python"

# Pipe from stdin
cat report.txt | alveare infer -s extract --max-tokens 1024
echo "Classify this" | alveare infer -s classify

Options:

• -s, --specialist <name> — Specialist to use (required)
• -m, --max-tokens <n> — Maximum tokens in response (default: 256)
• --json — Output raw JSON response

alveare chat

Start an interactive chat session.

alveare chat                  # default: chat specialist
alveare chat -s qa            # use a specific specialist
alveare chat -s code -m 1024  # with custom max tokens

In-session commands:

• /quit or /exit — End the session
• /clear — Clear conversation history
• /specialist <name> — Switch specialist mid-conversation

alveare models

List available specialists/models.

alveare models
alveare models --json

alveare usage

Show usage statistics for the current billing period.

alveare usage
alveare usage --json

alveare health

Check the API health status.

alveare health
alveare health --json

Configuration

The CLI resolves configuration in this order (highest priority first):

1. Command-line flags (--api-key, --base-url)
2. Environment variables (ALVEARE_API_KEY, ALVEARE_BASE_URL)
3. Config file (~/.alveare/config.json)

Environment Variables

| Variable | Description | |---|---| | ALVEARE_API_KEY | API key | | ALVEARE_BASE_URL | API base URL | | NO_COLOR | Disable colored output |

API Key Format

Alveare API keys follow the format:

• Live: alv_live_<32-hex-chars>
• Test: alv_test_<32-hex-chars>

Specialists

| Specialist | Description | |---|---| | classify | Text classification | | summarise | Text summarisation | | extract | Information extraction | | qa | Question answering | | chat | General conversation | | code | Code generation and assistance | | custom | Custom specialist |

Requirements

• Node.js >= 18.0.0 (uses native fetch)
• No runtime dependencies