> ## Documentation Index > Fetch the complete documentation index at: https://docs.praison.ai/llms.txt > Use this file to discover all available pages before exploring further. # CLI Reference > Complete command tree and flag reference for PraisonAI CLI ## Command Tree ``` praisonai ├── [direct prompt] # Any text → runs agent ├── [file.yaml] # YAML workflow execution ├── praisonai chat # TUI mode ├── praisonai chat # 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 # Add memory entry │ ├── search # Search memories │ ├── clear # Clear all memories │ ├── save # Save session │ ├── resume # Resume session │ ├── sessions # List sessions │ ├── compress # Compress memory │ ├── checkpoint # Create checkpoint │ ├── restore # Restore checkpoint │ └── checkpoints # List checkpoints │ ├── rules # Rules management │ ├── list # List all rules │ ├── show # Show specific rule │ ├── create # Create rule │ ├── delete # Delete rule │ └── stats # Rule statistics │ ├── workflow # Workflow management │ ├── list # List workflows │ ├── run # Run workflow │ ├── show # Show workflow details │ ├── create # Create workflow │ ├── validate # Validate workflow │ ├── template # Create from template │ └── auto # Auto-generate workflow │ ├── hooks # Hooks management │ ├── list # List hooks │ ├── stats # Hook statistics │ └── init # Create hooks.json │ ├── knowledge # Knowledge/RAG management │ ├── add # Add knowledge source │ ├── query # Query knowledge │ ├── list # List sources │ ├── clear # Clear knowledge │ └── stats # Knowledge statistics │ ├── session # Session management │ ├── start # Start new session │ ├── list # List sessions │ ├── resume # Resume session │ ├── delete # Delete session │ └── info # Session info │ ├── tools # Tool management │ ├── list # List available tools │ ├── info # Tool information │ └── search # Search tools │ ├── todo # Todo management │ ├── list # List todos │ ├── add # Add todo │ ├── complete # Complete todo │ ├── delete # 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 # Show config │ ├── create # Create config │ ├── delete # Delete config │ ├── enable # Enable config │ └── disable # Disable config │ ├── commit # AI commit message generation │ └── --push, -a/--auto, --no-verify │ ├── serve # API server │ └── --port --host │ ├── schedule # Task scheduling │ ├── start # Start scheduler │ ├── list # List jobs │ ├── stop # Stop job │ ├── logs # View logs │ ├── restart # Restart job │ ├── delete # Delete job │ ├── describe # Job details │ ├── save # Save state │ ├── stop-all # Stop all jobs │ └── stats # Scheduler stats │ ├── skills # Agent Skills management │ ├── list # List skills │ ├── validate # Validate skill │ ├── create # Create skill │ └── install # Install skill │ ├── profile # Profiling │ └── # 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) | Flag | Type | Description | | ------------------------- | --------- | ----------------------------------------------------------------------------------------- | | `--framework` | choice | Framework: crewai/autogen/praisonai | | `--ui` | choice | UI: chainlit/gradio | | `--auto` | remainder | Auto-generate agents | | `--init` | remainder | Initialize agents | | `--deploy` | flag | Deploy application | | `--schedule` | str | Schedule pattern | | `--schedule-config` | str | Schedule configuration file | | `--provider` | str | Cloud provider | | `--max-retries` | int | Max retry attempts | | `--llm` | str | LLM model | | `--model` | str | Model name | | `--hf` | str | HuggingFace model | | `--ollama` | str | Ollama model | | `--dataset` | str | Dataset path | | `--tools` | str | Tools path/names | | `--no-tools` | flag | Disable tools | | `--verbose` | flag | Verbose output | | `--save` | flag | Save output | | `--memory` | flag | Enable memory | | `--user-id` | str | User ID for memory | | `--planning` | flag | Planning mode | | `--planning-tools` | str | Planning tools | | `--planning-reasoning` | flag | Planning with reasoning | | `--auto-approve-plan` | flag | Auto-approve plans | | `--web-search` | flag | Native web search | | `--web-fetch` | flag | Web fetch | | `--prompt-caching` | flag | Prompt caching | | `--max-tokens` | int | Max output tokens | | `--final-agent` | str | Final agent name | | `--guardrail` | str | Output validation | | `--metrics` | flag | Token/cost metrics | | `--telemetry` | flag | Usage monitoring | | `--mcp` | str | MCP server command | | `--fast-context` | str | Codebase search | | `--handoff` | str | Agent delegation | | `--auto-memory` | flag | Auto memory extraction | | `--claude-memory` | flag | Claude memory format | | `--todo` | flag | Todo generation | | `--router` | flag | Smart model selection | | `--trust` | flag | Auto-approve tools | | `--approve-level` | str | Risk level approval | | `--sandbox` | str | Sandbox mode | | `--external-agent` | str | External CLI tool (claude/gemini/codex/cursor) — uses manager-Agent delegation by default | | `--external-agent-direct` | flag | Use external agent as direct proxy (skip manager Agent delegation) | | `--image` | str | Image analysis | | `--image-generate` | flag | Image generation | | `--file` | str | Input file | | `--url` | str | Input URL | | `--goal` | str | Goal/objective | | `--auto-analyze` | flag | Auto-analyze context | | `--query-rewrite` | flag | Query rewriting | | `--rewrite-tools` | str | Query rewrite tools | | `--expand-prompt` | flag | Prompt expansion | | `--expand-tools` | str | Prompt expansion tools | | `--public` | flag | Public deployment | | `--merge` | flag | Merge workflows | | `--claudecode` | flag | Claude Code integration | | `--realtime` | flag | Realtime mode | | `--call` | flag | Call mode | | `--workflow` | str | Workflow file | | `--workflow-var` | str | Workflow variables | | `--auto-save` | str | Auto-save name | | `--history` | int | History size | | `--include-rules` | str | Include rules | | `--checkpoint` | str | Checkpoint ID | | `--thinking` | str | Thinking budget | | `--compaction` | str | Compaction strategy | | `--output-style` | str | Output style | | `--policy` | str | Policy file | | `--background` | flag | Background execution | | `--lite` | flag | Lite mode (minimal dependencies) | | `praisonai chat` / `-i` | flag | Interactive TUI mode | | `praisonai chat` | flag | Single prompt chat mode | ## SDK Module Reference ### praisonaiagents (Core SDK) | Module | Location | Features | CLI Exposure | | ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | | **Agent** | `agent/agent.py` | Agent, ImageAgent, ContextAgent, DeepResearchAgent, QueryRewriterAgent, PromptExpanderAgent | Via wrapper CLI | | **Agents** | `agents/agents.py` | Multi-agent orchestration | Via wrapper CLI | | **Task** | `task/task.py` | Task definition | Via wrapper CLI | | **Tools** | `tools/` | 80+ tools (file, web, db, search, etc.) | `praisonai tools` | | **Memory** | `memory/` | FileMemory, Memory, RulesManager, AutoMemory, WorkflowManager, HooksManager, DocsManager, MCPConfigManager | `praisonai memory/rules/workflow/hooks/docs/mcp` | | **Knowledge** | `knowledge/` | RAG, chunking, vector stores, rerankers | `praisonai knowledge` | | **Workflows** | `workflows/` | Workflow, Pipeline, Route, Parallel, Loop, Repeat | `praisonai workflow` | | **MCP** | `mcp/` | MCP client, server, transports (HTTP, WebSocket, SSE) | `praisonai mcp` | | **DB** | `db/` | DbAdapter protocol, lazy backends | Via wrapper | | **Observability** | `obs/` | 16 providers (Langfuse, LangSmith, AgentOps, etc.) | `--telemetry` | | **Eval** | `eval/` | AccuracyEvaluator, PerformanceEvaluator, ReliabilityEvaluator, CriteriaEvaluator | `praisonai eval` | | **Skills** | `skills/` | SkillManager, SkillLoader, SkillValidator | `praisonai skills` | | **Planning** | `planning/` | Plan, PlanStep, TodoList, PlanStorage, PlanningAgent | `--planning` | | **Telemetry** | `telemetry/` | MinimalTelemetry, TelemetryCollector, PerformanceMonitor | `--telemetry` | | **Guardrails** | `guardrails/` | GuardrailResult, LLMGuardrail | `--guardrail` | | **Handoff** | `agent/handoff.py` | Agent-to-agent delegation | `--handoff` | | **Checkpoints** | `checkpoints/` | Shadow git checkpointing | `praisonai memory checkpoint` | | **Thinking** | `thinking/` | Thinking budget management | `praisonai thinking` | | **Compaction** | `compaction/` | Context compaction | `praisonai compaction` | | **Background** | `background/` | Background task execution | Via wrapper | | **Hooks** | `hooks/` | Event hooks, middleware | `praisonai hooks` | | **UI** | `ui/` | AGUI, A2A | `praisonai a2a` | | **LLM** | `llm/` | LLM client, model router, rate limiter | Internal | ### praisonai (Wrapper/CLI) | Module | Location | Features | CLI Exposure | | ---------------- | --------------- | ---------------------------------------------- | ------------------------- | | **CLI Main** | `cli/main.py` | PraisonAI class, argparse dispatcher | `praisonai` | | **CLI Features** | `cli/features/` | 50+ feature handlers | Various commands | | **Integrations** | `integrations/` | Claude Code, Gemini CLI, Codex CLI, Cursor CLI | `--external-agent` | | **Adapters** | `adapters/` | Readers, rerankers, retrievers, vector stores | Internal | | **Capabilities** | `capabilities/` | 27 LiteLLM-parity endpoints | `praisonai ` | | **Deploy** | `deploy/` | Docker, cloud providers | `praisonai deploy` | | **Auto** | `auto.py` | AutoGenerator, WorkflowAutoGenerator | `--auto`, `workflow auto` | | **Train** | `train.py` | Model training | `praisonai train` | | **Scheduler** | `scheduler/` | Job scheduling | `praisonai schedule` | | **Templates** | `templates/` | Agent templates | `praisonai templates` | | **UI** | `ui/` | Chainlit, Gradio interfaces | `praisonai ui/chat/code` | ## Quick Reference ### Common Commands ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} # 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 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 ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} # 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 ``` ## See Also * [CLI Commands](/docs/cli/cli) - Detailed CLI documentation * [Doctor CLI](/docs/cli/doctor) - Health checks and diagnostics * [Workflows](/docs/features/workflows) - Workflow management * [Memory](/docs/concepts/memory) - Memory and sessions * [Tools](/docs/tools) - Tool reference