CLI Reference

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

Installation

npm install -g @reminix/cli

Authentication

Authenticate with Reminix via browser-based OAuth.

reminix login

Flag	Description
`--no-browser`	Print 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

Flag	Description
`--verbose`	Show token creation time and credentials path

Deploying

The CLI is the script-friendly alternative to the GitHub deploy flow. Use it from your machine for local hotfixes, or from CI for fully scripted deploys.

`reminix deploy`

Deploy the current directory to Reminix.

reminix deploy

Flag	Description
`-p, --project <id>`	Project ID or `org-slug/project-slug`
`-d, --directory <path>`	Directory to deploy (default: `.`)
`--no-wait`	Don’t wait for the deployment to complete

The CLI tarballs the deploy directory, uploads it to a presigned URL, and starts the build. A few things to know:

Max size: 100 MB (compressed tarball).
Always excluded: .git, .env and .env.*, *.pem, *.key, node_modules, __pycache__, .venv, dist, build, .next, .idea, .DS_Store, and other common build/IDE artifacts. Your secrets and node_modules never get uploaded.
Custom excludes: add a .reminixignore file (one glob per line, # for comments) at the deploy root to exclude additional paths.

Use --no-wait for fire-and-forget deploys; otherwise the CLI streams build logs until the deploy reaches ready or failed.

`reminix deploy status`

Check deployment status or list recent deployments.

reminix deploy status              # list recent deployments
reminix deploy status <id>         # check a specific deployment

Flag	Description
`-p, --project <id>`	Project ID or `org-slug/project-slug`

Agents

The agent commands let you list, inspect, and invoke deployed agents from the command line. See Agents for the underlying concept.

`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. This is the CLI equivalent of the task interaction pattern.

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

Flag	Description
`--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
`--stream`	Stream the response
`-v, --verbose`	Show execution ID, status, duration, and log URL

`reminix agent chat <name>`

Send a chat message to an agent. This is the CLI equivalent of conversations.

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!"}]'

Flag	Description
`-m, --message <text>`	Message to send
`--history <json>`	Conversation history as JSON
`--stream`	Stream the response

`reminix agent workflow <name>`

Start a workflow run for a workflow agent. See Workflows for how pause and resume work.

reminix agent workflow my-workflow -i '{"task": "process"}'
reminix agent workflow my-workflow -i '{"task": "process"}' --stream

Flag	Description
`-i, --input <json>`	Input data as JSON
`--stream`	Stream the response
`-v, --verbose`	Show execution ID, status, duration, and log URL

Tools

The tool commands let you list, inspect, and call tools deployed via MCP.

`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"}'

Flag	Description
`-i, --input <json>`	Input data as JSON
`-v, --verbose`	Show 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

Project secrets are environment variables your handler reads at runtime. See Configuration & Secrets for the full reference and runtime read patterns.

`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-...

Flag	Description
`--sensitive <bool>`	Hide value in responses (default: `true`)

`reminix secret delete <key>`

Delete a secret.

reminix secret delete OPENAI_API_KEY

Workflows

Manage workflow runs from the command line. See Workflows for the underlying concept.

`reminix workflow list`

List workflow runs for the current project.

reminix workflow list
reminix workflow list --agent my-workflow --status paused

Flag	Description
`--agent <name>`	Filter by agent name
`--status <status>`	Filter by status (`running`, `paused`, `completed`, `failed`)
`--limit <number>`	Maximum number of runs to return

`reminix workflow show <runId>`

Show details of a workflow run.

reminix workflow show run_abc123

`reminix workflow resume <runId>`

Resume a paused workflow run by providing an action response.

reminix workflow resume run_abc123 -i '{"approved": true}'
reminix workflow resume run_abc123 -i '{"approved": true}' --stream

Flag	Description
`-i, --input <json>`	Action response as JSON
`--stream`	Stream the response
`-v, --verbose`	Show execution ID, status, duration, and log URL

Execution Logs

`reminix log list`

List execution logs for the current project.

reminix log list
reminix log list --type agent_invoke --status error
reminix log list --name my-agent --source cli

Flag	Description
`--type <type>`	Filter by type (`agent_invoke`, `agent_chat`, `tool_call`)
`--source <source>`	Filter by source (`api`, `cli`, `dashboard`, `widget`, `sdk`)
`--name <name>`	Filter by agent or tool name
`--status <status>`	Filter by status (`success`, `error`, `timeout`)
`--limit <number>`	Maximum number of logs to return

`reminix log show <id>`

Show details of an execution log including input/output.

reminix log show log_abc123

Conversations

`reminix conversation list`

List conversations for the current project.

reminix conversation list
reminix conversation list --agent my-chatbot

Flag	Description
`--agent <name>`	Filter by agent name
`--limit <number>`	Maximum number of conversations to return

`reminix conversation show <id>`

Show a conversation with all messages.

reminix conversation show conv_abc123

Usage

`reminix usage summary`

Show aggregated usage data for the project.

reminix usage summary

`reminix usage models`

List available models through Reminix AI credits.

reminix usage models

Client Tokens

Mint short-lived, scoped tokens for browser and mobile clients. See Authentication for when to use these.

`reminix token create`

Create a short-lived client token for browser SDK use.

reminix token create
reminix token create --metadata '{"displayName": "Jane"}' --ttl 7200
reminix token create --context '{"identity": {"user_id": "user_123"}}'

Flag	Description
`--metadata <json>`	Public metadata as JSON
`--context <json>`	Server context as JSON
`--ttl <seconds>`	Time-to-live in seconds (default: 3600, max: 86400)

`reminix token revoke <id>`

Revoke a client token immediately.

reminix token revoke tok_abc123

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, workflow, log, conversation, usage, token) accept:

Flag	Description
`-p, --project <id>`	Override the default project
`-o, --output <format>`	Output format: `json` or `table`

Next steps

Scripting

Pipe CLI output into shell scripts with --output json.

CI/CD

Use the CLI from GitHub Actions and other pipelines.

Coding Assistants

Use the CLI inside Claude Code, Cursor, and Windsurf.

Configuration & Secrets

The full reference for reminix secret set and runtime env vars.

Guides

​Installation

​Authentication

​reminix login

​reminix logout

​reminix whoami

​Deploying

​reminix deploy

​reminix deploy status

​Agents

​reminix agent list

​reminix agent show <name>

​reminix agent invoke <name>

​reminix agent chat <name>

​reminix agent workflow <name>

​Tools

​reminix tool list

​reminix tool show <name>

​reminix tool call <name>

​Projects

​reminix project list

​reminix project show

​reminix project select

​reminix project clear

​Secrets

​reminix secret list

​reminix secret set <key> <value>

​reminix secret delete <key>

​Workflows

​reminix workflow list

​reminix workflow show <runId>

​reminix workflow resume <runId>

​Execution Logs

​reminix log list

​reminix log show <id>

​Conversations

​reminix conversation list

​reminix conversation show <id>

​Usage

​reminix usage summary

​reminix usage models

​Client Tokens

​reminix token create

​reminix token revoke <id>

​Configuration

​reminix config set <key> <value>

​reminix config get <key>

​reminix config list

​Global flags

​Next steps