CLI Reference

praisonai
├── [direct prompt]              # Any text → runs agent (in-process on standalone as of PR #2853)
├── (bare, no subcommand)        # Interactive TUI; accepts -c/--continue, -s/--session <id>, --fork (PR #4912)
├── [file.yaml]                  # YAML workflow execution
├── praisonai chat           # TUI mode (resident standalone; wrapper adds richer dispatch)
├── praisonai chat                  # Single prompt chat mode (resident standalone; wrapper adds richer dispatch)
│
├── chat                         # Chainlit chat UI (port 8084)
├── code                         # Chainlit code UI (port 8086)
├── call                         # PraisonAI Call server
│   └── --port --host --public
├── realtime                     # Realtime voice UI (port 8088)
├── train                        # Model training
├── ui                           # Gradio/Chainlit UI (port 8082)
│
├── context                      # Context engineering
│   └── --url, --goal, --auto-analyze
├── research                     # Deep research agent
│   └── --query-rewrite, --tools (file path OR comma-separated names via full resolver), --save
│
├── checkpoint                   # File-level shadow-git checkpoints
│   ├── save <msg>               # Snapshot the workspace
│   │   └── --allow-empty, -w
│   ├── list                     # Show recent checkpoints (newest first)
│   │   └── --limit/-n, -w
│   ├── restore <id|last>        # Rewind workspace to a checkpoint
│   │   └── -w
│   ├── diff [from] [to]         # Diff between checkpoints or working dir
│   │   └── -w
│   └── delete                   # Delete all checkpoints
│       └── --yes/-y, -w
│
├── memory                       # Memory management
│   ├── show                     # Show current memory (--limit N, --user-id ID)
│   ├── list                     # Alias for show (--limit N, --user-id ID)
│   ├── add <content>            # Add memory entry
│   ├── search <query>           # Search memories
│   ├── clear                    # Clear all memories
│   ├── save <name>              # Save session
│   ├── resume <name>            # Resume session
│   ├── sessions                 # List sessions
│   ├── compress                 # Compress memory
│   ├── checkpoint               # Create memory checkpoint
│   ├── restore <id>             # Restore memory checkpoint
│   └── checkpoints              # List memory checkpoints
│
├── rules                        # Rules management
│   ├── list                     # List all rules
│   ├── show <name>              # Show specific rule
│   ├── create <name> <content>  # Create rule
│   ├── delete <name>            # Delete rule
│   └── stats                    # Rule statistics
│
├── workflow                     # Workflow management
│   ├── list                     # List workflows
│   ├── run <file>               # Run workflow
│   ├── show <file>              # Show workflow details
│   ├── create                   # Create workflow
│   ├── validate <file>          # Validate workflow
│   ├── template <name>          # Create from template
│   └── auto <topic>             # Auto-generate workflow
│
├── flow                         # Visual workflow builder (Langflow)
│   ├── (no args)                # Start the builder UI
│   ├── import <file>            # Import YAML → Langflow
│   ├── export <flow_id>         # Export Langflow → YAML/JSON
│   ├── list                     # List flows on a server
│   └── version                  # Show Langflow version
│
├── hooks                        # Hooks management
│   ├── list                     # List hooks
│   ├── stats                    # Hook statistics
│   └── init                     # Create hooks.json
│
├── knowledge                    # Knowledge/RAG management
│   ├── add <source>             # Add knowledge source
│   ├── query <query>            # Query knowledge
│   ├── list                     # List sources
│   ├── clear                    # Clear knowledge
│   └── stats                    # Knowledge statistics
│
├── session                      # Session management
│   ├── start                    # Start new session
│   ├── list                     # List sessions
│   ├── resume <id> [PROMPT]     # Resume session with full state restore
│   │   └── --transcript         # Show transcript only (no state restore)
│   ├── delete <id>              # Delete session
│   └── info <id>                # Session info
│
├── usage                        # Local token/cost usage reporting
│   └── --days/-d --by/-b --project/-p --json
│
├── tools                        # Tool management
│   ├── list                     # List available tools
│   ├── info <name>              # Tool information
│   └── search <query>           # Search tools
│
├── todo                         # Todo management
│   ├── list                     # List todos
│   ├── add <content>            # Add todo
│   ├── complete <id>            # Complete todo
│   ├── delete <id>              # Delete todo
│   └── clear                    # Clear all todos
│
├── docs                         # Documentation management
│   ├── run                      # Run doc code validation
│   ├── list                     # List docs/code blocks
│   ├── stats                    # Show group statistics
│   ├── run-all                  # Run all groups
│   ├── report [path]            # View execution report
│   │   └── --limit, --wide, --match, --group, --format
│   ├── cli                      # CLI command validation
│   │   ├── run-all              # Validate all CLI commands
│   │   ├── list                 # List CLI commands
│   │   ├── stats                # CLI command statistics
│   │   └── report               # View CLI validation report
│   ├── api-md                   # Generate API reference (api.md)
│   │   └── --write, --check, --stdout
│   ├── generate                 # Generate documentation
│   └── serve                    # Serve docs locally
│
├── examples                     # Examples management
│   ├── run                      # Run examples
│   ├── list                     # List examples
│   ├── stats                    # Show group statistics
│   ├── run-all                  # Run all groups
│   └── report [path]            # View execution report
│       └── --limit, --wide, --match, --group, --format
│
├── mcp                          # MCP server management
│   ├── list                     # List MCP configs
│   ├── show <name>              # Show config
│   ├── create <name> <cmd>      # Create config
│   ├── delete <name>            # Delete config
│   ├── enable <name>            # Enable config
│   └── disable <name>           # Disable config
│
├── commit                       # AI commit message generation
│   └── --push, -a/--auto, --no-verify
│
├── serve                        # API server
│   └── <agents.yaml> --port --host
│
├── schedule                     # Task scheduling
│   ├── start                    # Start scheduler
│   ├── list                     # List jobs
│   ├── stop <id>                # Stop job
│   ├── logs <id>                # View logs
│   ├── restart <id>             # Restart job
│   ├── delete <id>              # Delete job
│   ├── describe <id>            # Job details
│   ├── save                     # Save state
│   ├── stop-all                 # Stop all jobs
│   └── stats                    # Scheduler stats
│
├── skills                       # Agent Skills management
│   ├── list                     # List skills
│   ├── validate <path>          # Validate skill
│   ├── create <name>            # Create skill
│   └── install <repo>           # Install skill
│
├── profile                      # Profiling
│   └── <prompt>                 # Profile agent execution
│
├── eval                         # Evaluation framework
│   ├── accuracy                 # Accuracy evaluation
│   ├── performance              # Performance benchmark
│   ├── reliability              # Tool reliability check
│   └── criteria                 # Custom criteria eval
│
├── doctor                       # Health checks & diagnostics
│   ├── env                      # Environment checks
│   ├── config                   # Configuration validation
│   ├── tools                    # Tool availability
│   ├── db                       # Database checks
│   ├── mcp                      # MCP configuration
│   ├── obs                      # Observability providers
│   ├── skills                   # Agent skills
│   ├── memory                   # Memory storage
│   ├── permissions              # Filesystem permissions
│   ├── network                  # Network connectivity
│   ├── performance              # Import times
│   ├── ci                       # CI mode
│   └── selftest                 # Agent functionality
│
├── agent                        # Custom agent definitions
│   ├── create [name]            # Author a new custom agent (interactive or --yes)
│   ├── list   [--verbose]       # List discovered custom agents
│   └── show   <name>            # Show agent details
│
├── auth                         # Credential management
│   ├── login <provider>         # Store provider key (interactive or --key)
│   ├── list                     # List stored providers (redacted)
│   ├── status [provider]        # Validate stored credentials
│   └── logout [provider|--all]  # Remove credentials
│
├── command                      # Custom command templates
│   ├── list [--verbose]         # List discovered commands
│   └── show <name> [--preview]  # Show / preview a command template
│
├── models                       # LLM model catalogue
│   ├── list [SEARCH]            # List/filter models by provider or name
│   ├── describe <model>         # Full capabilities/limits/cost
│   └── validate <model>         # Validate an ID; suggests alternatives on miss
│
├── permissions                  # Tool approval rules
│   ├── list                     # List rules
│   ├── allow|deny|ask <pattern> # Add a rule
│   ├── remove <id-prefix>       # Remove a rule
│   ├── reset                    # Delete all rules (confirm)
│   ├── export                   # Print rules as JSON
│   └── import <file>            # Import rules from JSON
│
├── validate                     # YAML configuration validation
│   ├── <file>                   # Validate one file
│   ├── check [directory]        # Validate all YAML in directory
│   └── schema                   # Print the YAML schema
│
├── agents                       # Agent management
├── run                          # Run agents
├── thinking                     # Thinking budget config
├── compaction                   # Context compaction config
├── output                       # Output style config
│
├── deploy                       # Deployment management
│   ├── init                     # Initialize deployment
│   ├── validate                 # Validate config
│   ├── plan                     # Show deployment plan
│   ├── status                   # Deployment status
│   ├── destroy                  # Destroy deployment
│   ├── run                      # Run deployment
│   ├── api                      # API deployment
│   ├── docker                   # Docker deployment
│   └── cloud                    # Cloud deployment
│
├── templates                    # Template management
│
├── backends                     # List registered external coding-CLI backends
│   └── list                     # Explicit form (same as bare `backends`)
│
└── [Capabilities - LiteLLM parity] (27 commands)     # route to legacy handlers (except ⚠ verbs)
    ├── audio                    # Audio transcription/TTS
    ├── embed                    # Embeddings
    ├── images                   # Image generation
    ├── moderate                 # Content moderation
    ├── files                    # File management
    ├── batches                  # Batch processing
    ├── vector-stores            # Vector store management  ⚠ still billed to LLM pending #4322
    ├── rerank                   # Reranking
    ├── ocr                      # OCR
    ├── assistants               # Assistants API
    ├── fine-tuning              # Fine-tuning
    ├── completions              # Completions
    ├── messages                 # Messages
    ├── guardrails               # Guardrails
    ├── rag                      # RAG
    ├── videos                   # Video processing
    ├── a2a                      # Agent-to-Agent
    ├── containers               # Container management  ⚠ still billed to LLM pending #4322
    ├── passthrough              # Passthrough requests
    ├── responses                # Response management
    ├── search                   # Search
    └── realtime-api             # Realtime API

praisonai "summarise this folder"   # bare prompt → Typer run (modern engine)
praisonai show                      # bare token → Typer run, prompt "show"
praisonai memoyr                    # close typo of memory → exit 2, Did you mean: memory?
praisonai agents.yaml               # flagless .yaml → Typer run (modern engine)
praisonai memory show               # known subcommand → routed normally

praisonai show --framework crewai   # flag → legacy; ⚠ reserved-verb hint, exit 2

# Run agent with prompt
praisonai "Create a blog post about AI"

# Run workflow
praisonai workflow.yaml

# Interactive mode
praisonai chat

# Chat UI
praisonai chat

# Health checks
praisonai doctor

# Memory management
praisonai memory show                # 10 most recent
praisonai memory list --limit 25     # alias for show
praisonai memory add "Important context"

# Tool management
praisonai tools list
praisonai tools list --source registered

# Workflow management
praisonai workflow list
praisonai workflow auto "Research AI trends"

# Visual workflow builder
praisonai flow
praisonai flow import workflow.yaml --open
praisonai flow export <flow_id> -o my_flow.yaml

# Deployment
praisonai deploy init
praisonai deploy run

# Agent with memory and planning
praisonai "Task" --memory --planning

# Agent with web search and tools
praisonai "Research topic" --web-search --tools

# Agent with external CLI tool (delegated via manager)
praisonai "Refactor code" --external-agent claude

# Agent with external CLI tool (direct proxy)
praisonai "Refactor code" --external-agent claude --external-agent-direct

# Agent with guardrails and metrics
praisonai "Generate content" --guardrail --metrics

# CI mode with JSON output
praisonai doctor ci --json --output report.json

# Before: Raw Python traceback
Traceback (most recent call last):
  ...
BudgetExceededError: Agent 'Researcher' exceeded budget: $1.2500 >= $1.0000

# After: Clean CLI message
Budget limit exceeded: [budget] Agent 'Researcher' exceeded budget: $1.2500 >= $1.0000
- Set max_budget parameter (e.g., Agent(max_budget=1.00))

No provider credential detected — scaffolded placeholder model 'gpt-4o-mini'.
Set one of OPENAI_API_KEY, ANTHROPIC_API_KEY, GEMINI_API_KEY/GOOGLE_API_KEY,
GROQ_API_KEY, COHERE_API_KEY or OLLAMA_HOST, then update the model if needed.

Detected provider — scaffolded model: anthropic/claude-3-5-sonnet-latest

# List sessions to find an ID
praisonai session list

# Resume (restores model + history)
praisonai session resume <session_id>

# Resume and continue with a new prompt
praisonai session resume <session_id> "what should I do next?"

# Show transcript only (no state restore)
praisonai session resume <session_id> --transcript

# Last 30 days, grouped by day
praisonai usage

# Group by model or project
praisonai usage --by model
praisonai usage --by project

# Window and JSON output
praisonai usage --days 7
praisonai usage --json