@reminix/cli

Official CLI for Reminix — deploy and manage AI agents from the command line.

Installation

npm install -g @reminix/cli

Or with other package managers:

pnpm add -g @reminix/cli
yarn global add @reminix/cli

Quick Start

# Login to your Reminix account
reminix login

# Select your default project interactively
reminix project select

# Deploy your project
reminix deploy

# List agents and tools
reminix agent list
reminix tool list

# Invoke a task agent
reminix agent invoke my-agent --prompt "Hello!"

# Invoke a chat agent
reminix agent invoke chat-bot --message "Hello!"

# Invoke with custom input
reminix agent invoke calculator -i '{"a": 5, "b": 3}'

# Stream the response
reminix agent invoke my-agent --prompt "Write a story" --stream

# Show execution id, status, duration and log URL
reminix agent invoke my-agent --prompt "Hello" -v

# Call a tool
reminix tool call my-tool -i '{"name": "World"}'

# Call a tool with verbose (show execution details)
reminix tool call my-tool -i '{"name": "World"}' -v

Commands

| Command | Description | |---------|-------------| | reminix login | Authenticate with Reminix | | reminix logout | Clear authentication | | reminix whoami | Show current user | | reminix project list | List all projects | | reminix project show | Show current project details | | reminix project select | Interactively select a default project | | reminix project clear | Clear the default project | | reminix agent list | List all agents | | reminix agent show <name> | Show agent details | | reminix agent invoke <name> | Invoke an agent | | reminix tool list | List all tools | | reminix tool show <name> | Show tool details | | reminix tool call <name> | Call a tool with input | | reminix secret list | List all secrets for the project | | reminix secret set <key> <value> | Set a secret (create or update) | | reminix secret delete <key> | Delete a secret | | reminix deploy | Deploy the current project | | reminix deploy status | List recent deployments | | reminix deploy status <id> | Get deployment status | | reminix config set <key> <value> | Set configuration value | | reminix config get <key> | Get configuration value | | reminix config list | List all configuration |

Agent Invoke Options

| Option | Description | |--------|-------------| | --prompt <text> | Prompt for task agents | | --message <text> | Single user message for chat agents (like --prompt) | | --messages <json> | Messages array for chat agents (JSON, multi-turn) | | -i, --input <json> | Custom input data for agents with custom input schema | | --stream | Stream the response | | -v, --verbose | Show execution id, status, duration and log URL | | -p, --project <id> | Project ID or org-slug/project-slug | | -o, --output <format> | Output format (json, table) |

Tool Call Options

| Option | Description | |--------|-------------| | -i, --input <json> | Input data as JSON (required) | | -v, --verbose | Show execution id, status, duration and log URL | | -p, --project <id> | Project ID or org-slug/project-slug | | -o, --output <format> | Output format (json, table) |

Configuration

Default Project

Set a default project to avoid passing -p on every command:

reminix config set project acme/my-app

Environment Variables

| Variable | Description | |----------|-------------| | REMINIX_PROJECT | Default project (overrides config file) | | REMINIX_API_URL | API URL (for self-hosted instances) |

Priority: CLI flag (-p) → Environment variable → Config file

Output Formats

Most commands support -o, --output for different output formats:

# Human-readable table (default)
reminix project list

# JSON (for scripting)
reminix project list -o json

Documentation

Full documentation: reminix.com/docs

License

Apache-2.0