Skip to main content

​
Command Tree

praisonai
├── [direct prompt]              # Any text → runs agent
├── [file.yaml]                  # YAML workflow execution
├── --interactive / -i           # TUI mode
├── --chat-mode                  # Single prompt chat mode
│
├── chat                         # Chainlit chat UI (port 8084)
├── code                         # Chainlit code UI (port 8086)
├── call                         # PraisonAI Call server
├── 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, --save
│
├── memory                       # Memory management
│   ├── show                     # Show current memory
│   ├── 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 checkpoint
│   ├── restore <id>             # Restore checkpoint
│   └── checkpoints              # List 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
│
├── 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>              # Resume session
│   ├── delete <id>              # Delete session
│   └── info <id>                # Session info
│
├── 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
│   ├── list                     # List docs
│   ├── show <name>              # Show doc
│   ├── create <name> <content>  # Create doc
│   └── delete <name>            # Delete doc
│
├── 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
│
├── 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
│
└── [Capabilities - LiteLLM parity] (27 commands)
    ├── audio                    # Audio transcription/TTS
    ├── embed                    # Embeddings
    ├── images                   # Image generation
    ├── moderate                 # Content moderation
    ├── files                    # File management
    ├── batches                  # Batch processing
    ├── vector-stores            # Vector store management
    ├── 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
    ├── passthrough              # Passthrough requests
    ├── responses                # Response management
    ├── search                   # Search
    └── realtime-api             # Realtime API

​
Global Flags (70+ flags)

FlagTypeDescription
--frameworkchoiceFramework: crewai/autogen/praisonai
--uichoiceUI: chainlit/gradio
--autoremainderAuto-generate agents
--initremainderInitialize agents
--deployflagDeploy application
--schedulestrSchedule pattern
--schedule-configstrSchedule configuration file
--providerstrCloud provider
--max-retriesintMax retry attempts
--llmstrLLM model
--modelstrModel name
--hfstrHuggingFace model
--ollamastrOllama model
--datasetstrDataset path
--toolsstrTools path/names
--no-toolsflagDisable tools
--verboseflagVerbose output
--saveflagSave output
--memoryflagEnable memory
--user-idstrUser ID for memory
--planningflagPlanning mode
--planning-toolsstrPlanning tools
--planning-reasoningflagPlanning with reasoning
--auto-approve-planflagAuto-approve plans
--web-searchflagNative web search
--web-fetchflagWeb fetch
--prompt-cachingflagPrompt caching
--max-tokensintMax output tokens
--final-agentstrFinal agent name
--guardrailstrOutput validation
--metricsflagToken/cost metrics
--telemetryflagUsage monitoring
--mcpstrMCP server command
--fast-contextstrCodebase search
--handoffstrAgent delegation
--auto-memoryflagAuto memory extraction
--claude-memoryflagClaude memory format
--todoflagTodo generation
--routerflagSmart model selection
--trustflagAuto-approve tools
--approve-levelstrRisk level approval
--sandboxstrSandbox mode
--external-agentstrExternal CLI tool (claude/gemini/codex/cursor)
--imagestrImage analysis
--image-generateflagImage generation
--filestrInput file
--urlstrInput URL
--goalstrGoal/objective
--auto-analyzeflagAuto-analyze context
--query-rewriteflagQuery rewriting
--rewrite-toolsstrQuery rewrite tools
--expand-promptflagPrompt expansion
--expand-toolsstrPrompt expansion tools
--publicflagPublic deployment
--mergeflagMerge workflows
--claudecodeflagClaude Code integration
--realtimeflagRealtime mode
--callflagCall mode
--workflowstrWorkflow file
--workflow-varstrWorkflow variables
--auto-savestrAuto-save name
--historyintHistory size
--include-rulesstrInclude rules
--checkpointstrCheckpoint ID
--thinkingstrThinking budget
--compactionstrCompaction strategy
--output-stylestrOutput style
--policystrPolicy file
--backgroundflagBackground execution
--liteflagLite mode (minimal dependencies)
--interactive / -iflagInteractive TUI mode
--chat-modeflagSingle prompt chat mode

​
SDK Module Reference

​
praisonaiagents (Core SDK)

ModuleLocationFeaturesCLI Exposure
Agentagent/agent.pyAgent, ImageAgent, ContextAgent, DeepResearchAgent, QueryRewriterAgent, PromptExpanderAgentVia wrapper CLI
PraisonAIAgentsagents/agents.pyMulti-agent orchestrationVia wrapper CLI
Tasktask/task.pyTask definitionVia wrapper CLI
Toolstools/80+ tools (file, web, db, search, etc.)praisonai tools
Memorymemory/FileMemory, Memory, RulesManager, AutoMemory, WorkflowManager, HooksManager, DocsManager, MCPConfigManagerpraisonai memory/rules/workflow/hooks/docs/mcp
Knowledgeknowledge/RAG, chunking, vector stores, rerankerspraisonai knowledge
Workflowsworkflows/Workflow, Pipeline, Route, Parallel, Loop, Repeatpraisonai workflow
MCPmcp/MCP client, server, transports (HTTP, WebSocket, SSE)praisonai mcp
DBdb/DbAdapter protocol, lazy backendsVia wrapper
Observabilityobs/16 providers (Langfuse, LangSmith, AgentOps, etc.)--telemetry
Evaleval/AccuracyEvaluator, PerformanceEvaluator, ReliabilityEvaluator, CriteriaEvaluatorpraisonai eval
Skillsskills/SkillManager, SkillLoader, SkillValidatorpraisonai skills
Planningplanning/Plan, PlanStep, TodoList, PlanStorage, PlanningAgent--planning
Telemetrytelemetry/MinimalTelemetry, TelemetryCollector, PerformanceMonitor--telemetry
Guardrailsguardrails/GuardrailResult, LLMGuardrail--guardrail
Handoffagent/handoff.pyAgent-to-agent delegation--handoff
Checkpointscheckpoints/Shadow git checkpointingpraisonai memory checkpoint
Thinkingthinking/Thinking budget managementpraisonai thinking
Compactioncompaction/Context compactionpraisonai compaction
Backgroundbackground/Background task executionVia wrapper
Hookshooks/Event hooks, middlewarepraisonai hooks
UIui/AGUI, A2Apraisonai a2a
LLMllm/LLM client, model router, rate limiterInternal

​
praisonai (Wrapper/CLI)

ModuleLocationFeaturesCLI Exposure
CLI Maincli/main.pyPraisonAI class, argparse dispatcherpraisonai
CLI Featurescli/features/50+ feature handlersVarious commands
Integrationsintegrations/Claude Code, Gemini CLI, Codex CLI, Cursor CLI--external-agent
Adaptersadapters/Readers, rerankers, retrievers, vector storesInternal
Capabilitiescapabilities/27 LiteLLM-parity endpointspraisonai <capability>
Deploydeploy/Docker, cloud providerspraisonai deploy
Autoauto.pyAutoGenerator, WorkflowAutoGenerator--auto, workflow auto
Traintrain.pyModel trainingpraisonai train
Schedulerscheduler/Job schedulingpraisonai schedule
Templatestemplates/Agent templatespraisonai templates
UIui/Chainlit, Gradio interfacespraisonai ui/chat/code

​
Quick Reference

​
Common Commands

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

# Run workflow
praisonai workflow.yaml

# Interactive mode
praisonai --interactive

# Chat UI
praisonai chat

# Health checks
praisonai doctor

# Memory management
praisonai memory show
praisonai memory add "Important context"

# Tool management
praisonai tools list

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

# Deployment
praisonai deploy init
praisonai deploy run

​
Common Flag Combinations

# 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
praisonai "Refactor code" --external-agent claude

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

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

​
See Also