CLI Reference

RestFlow provides a powerful command-line interface for managing agents, secrets, and the daemon service. Both restflow and rf command names are supported (via Homebrew and npm installs).

Installation

Homebrew (macOS/Linux)

brew install lhwzds/tap/restflow

npm (Cross-platform)

npm install -g restflow-cli

Build from Source

cargo install --git https://github.com/lhwzds/restflow --package restflow-cli

Commands Overview

Command	Description
restflow start	Start the daemon (background service)
restflow stop	Stop the daemon
restflow status	Show daemon status
restflow restart	Restart the daemon
restflow upgrade	Upgrade CLI to latest release
restflow daemon	Daemon management (start/stop/status/restart)
restflow agent	Agent management (list/show/create/update/delete)
restflow auth	Authentication profile management
restflow key	API key management
restflow skill	Skill management
restflow secret	Secret management
restflow memory	Memory operations
restflow session	Chat session management
restflow security	Security approvals and allowlists
restflow config	Configuration management
restflow mcp	MCP server management
restflow hook	Hook management
restflow info	Show system information
restflow completions	Generate shell completions

Daemon Commands

The daemon runs in the background, enabling Telegram bot integration, scheduled tasks, and the MCP HTTP server (port 8787).

# Start daemon (shorthand)
restflow start

# Start daemon with daemon subcommand
restflow daemon start

# Start in foreground (for debugging)
restflow daemon start --foreground

# Custom MCP port
restflow daemon start --mcp-port 9000

# Check status
restflow status
# or
restflow daemon status

# Stop daemon
restflow stop

# Restart
restflow restart

Agent Commands

Manage AI agents.

# List agents
restflow agent list

# Show agent details
restflow agent show <ID>

# Create agent
restflow agent create --name "My Agent" --model sonnet

# Update agent
restflow agent update <ID> --name "New Name" --model opus

# Delete agent
restflow agent delete <ID>

Auth Commands

Manage authentication profiles for LLM providers.

# Add a new auth profile
restflow auth add --provider claude-code --key "sk-ant-oat01-..." --name "My Claude Code"

# List auth profiles
restflow auth list

# Show profile details
restflow auth show <ID>

# Remove profile
restflow auth remove <ID>

# Check auth status
restflow auth status

# Auto-discover credentials
restflow auth discover

See Authentication for details on obtaining and configuring credentials.

Key Commands

Simplified API key management.

# Add API key
restflow key add anthropic sk-ant-xxx

# List keys
restflow key list

# Show key details
restflow key show <ID>

# Use a key as default
restflow key use <ID>

# Test a key
restflow key test <ID>

# Remove a key
restflow key remove <ID>

# Auto-discover keys from environment
restflow key discover

Secret Commands

Manage API keys and credentials stored in the encrypted database.

# Set a secret
restflow secret set ANTHROPIC_API_KEY sk-ant-xxx

# List secrets
restflow secret list

# Check if a secret exists
restflow secret has ANTHROPIC_API_KEY

# Delete a secret
restflow secret delete ANTHROPIC_API_KEY

Memory Commands

Manage agent long-term memory.

# Search memory
restflow memory search "deployment process"

# List memory entries
restflow memory list

# Export memory
restflow memory export

# Show memory stats
restflow memory stats

# Clear all memory
restflow memory clear

Skill Commands

Manage reusable skills.

# List skills
restflow skill list

# Show skill
restflow skill show <ID>

# Create skill
restflow skill create --name "My Skill"

# Import skill from file
restflow skill import ./my-skill.md

# Export skill
restflow skill export <ID>

# Search skills
restflow skill search "web scraping"

# Install skill from source
restflow skill install <SOURCE>

# Delete skill
restflow skill delete <ID>

Session Commands

Manage chat sessions.

# List sessions
restflow session list

# Show session details
restflow session show <ID>

# Create a new session
restflow session create

# Search sessions
restflow session search "topic"

# Delete session
restflow session delete <ID>

Security Commands

Manage security approvals and allowlists.

# List pending approvals
restflow security approvals

# Approve a pending request
restflow security approve <ID>

# Reject a pending request
restflow security reject <ID>

# Show allowlist
restflow security allowlist show

# Add to allowlist
restflow security allowlist add <PATTERN>

# Remove from allowlist
restflow security allowlist remove <PATTERN>

MCP Commands

Manage MCP (Model Context Protocol) servers.

# List MCP servers
restflow mcp list

# Add MCP server
restflow mcp add <NAME> <COMMAND>

# Remove MCP server
restflow mcp remove <NAME>

# Start MCP server
restflow mcp start <NAME>

# Stop MCP server
restflow mcp stop <NAME>

# Serve as MCP stdio server
restflow mcp serve

Config Commands

Manage RestFlow configuration.

# Show all config
restflow config show

# Get a specific config value
restflow config get <KEY>

# Set a config value
restflow config set <KEY> <VALUE>

# Reset config to defaults
restflow config reset

Hook Commands

Manage event hooks (webhooks, scripts, notifications).

# List hooks
restflow hook list

# Create a hook
restflow hook create --name "Deploy Notify" --event task_completed --action send_message

# Delete a hook
restflow hook delete <ID>

# Test a hook
restflow hook test <ID>

Shell Completions

Generate shell completions for your shell:

# Bash
restflow completions bash > restflow.bash

# Zsh
restflow completions zsh > _restflow

# Fish
restflow completions fish > restflow.fish

Other Commands

# Show system information
restflow info

# Upgrade to latest version
restflow upgrade

# Migrate configuration from old locations
restflow migrate
restflow migrate --dry-run  # Preview changes

Global Options

These options are available for all commands:

Option	Description
--db-path <PATH>	Custom database path
-v, --verbose	Enable verbose logging
--format <FORMAT>	Output format (text, json)
-h, --help	Print help
-V, --version	Print version