Skip to main content
The Reminix CLI is the fastest way to deploy and manage agents and tools from your terminal.

Installation

npm install -g @reminix/cli

Authentication

reminix login

Authenticate with Reminix via browser-based OAuth.
reminix login
FlagDescription
--no-browserPrint the URL instead of opening the browser
After login, you’ll be prompted to select a default project.

reminix logout

Clear stored credentials and project config.
reminix logout

reminix whoami

Show the currently logged-in user.
reminix whoami
reminix whoami --verbose
FlagDescription
--verboseShow token creation time and credentials path

Deploying

reminix deploy

Deploy the current directory to Reminix.
reminix deploy
FlagDescription
-p, --project <id>Project ID or org-slug/project-slug
-d, --directory <path>Directory to deploy (default: .)
--no-waitDon’t wait for the deployment to complete

reminix deploy status

Check deployment status or list recent deployments.
reminix deploy status              # list recent deployments
reminix deploy status <id>         # check a specific deployment
FlagDescription
-p, --project <id>Project ID or org-slug/project-slug

Agents

reminix agent list

List agents in the current project.
reminix agent list

reminix agent show <name>

Show details of an agent.
reminix agent show my-agent

reminix agent invoke <name>

Invoke an agent with input.
reminix agent invoke my-agent --prompt "Summarize this document"
reminix agent invoke my-agent --message "Hello"
reminix agent invoke my-agent --input '{"task": "analyze", "data": [1,2,3]}'
reminix agent invoke my-agent --prompt "Stream this" --stream
FlagDescription
--prompt <text>Prompt string (for prompt-type agents)
--message <text>Single user message (for chat/thread agents)
--messages <json>Messages array as JSON
-i, --input <json>Arbitrary input as JSON
--streamStream the response
-v, --verboseShow execution ID, status, duration, and log URL

reminix agent chat <name>

Send a chat message to an agent.
reminix agent chat my-agent -m "What can you help me with?"
reminix agent chat my-agent -m "Follow up" --history '[{"role":"user","content":"Hi"},{"role":"assistant","content":"Hello!"}]'
FlagDescription
-m, --message <text>Message to send
--history <json>Conversation history as JSON
--streamStream the response

Tools

reminix tool list

List tools in the current project.
reminix tool list

reminix tool show <name>

Show details of a tool.
reminix tool show my-tool

reminix tool call <name>

Call a tool with input data.
reminix tool call my-tool -i '{"url": "https://example.com"}'
FlagDescription
-i, --input <json>Input data as JSON
-v, --verboseShow execution ID, status, duration, and log URL

Projects

reminix project list

List projects you have access to.
reminix project list

reminix project show

Show details of the current project.
reminix project show

reminix project select

Interactively select and set the default project.
reminix project select

reminix project clear

Clear the default project.
reminix project clear

Secrets

reminix secret list

List secrets for the current project. Values are hidden by default.
reminix secret list

reminix secret set <key> <value>

Create or update a secret.
reminix secret set OPENAI_API_KEY sk-...
FlagDescription
--sensitive <bool>Hide value in responses (default: true)

reminix secret delete <key>

Delete a secret.
reminix secret delete OPENAI_API_KEY

Configuration

reminix config set <key> <value>

Set a configuration value.
reminix config set project my-org/my-project

reminix config get <key>

Get a configuration value.
reminix config get project

reminix config list

List all configuration values.
reminix config list

Global flags

All resource commands (agent, tool, secret, deploy) accept:
FlagDescription
-p, --project <id>Override the default project
-o, --output <format>Output format: json or table