PraisonAI TypeScript CLI
Thepraisonai-ts CLI provides a complete command-line interface for the PraisonAI TypeScript SDK.
Installation
Quick Start
Global Options
| Option | Short | Description |
|---|---|---|
--verbose | -v | Enable verbose output |
--config | -c | Path to config file |
--profile | -p | Profile name to use |
--output | -o | Output format (json, text, pretty) |
--json | Shorthand for —output json |
Environment Variables
| Variable | Description |
|---|---|
OPENAI_API_KEY | OpenAI API key |
ANTHROPIC_API_KEY | Anthropic API key |
GOOGLE_API_KEY | Google API key |
PRAISONAI_MODEL | Default model |
Commands Reference
Core Commands
chat
Chat with an AI agent.| Flag | Description |
|---|---|
--model, -m | Model to use |
--stream, -s | Enable streaming |
--session | Session ID for continuity |
run
Run an agent with a task.| Flag | Description |
|---|---|
--agent, -a | Agent configuration file |
--tools, -t | Comma-separated tools |
workflow
Execute a multi-agent workflow.Agent Generation
auto
Auto-generate agents from a topic.| Flag | Description |
|---|---|
--pattern | Agent pattern (sequential, parallel, routing) |
--agents | Number of agents to generate |
Specialized Agents
image
Image generation and analysis.| Flag | Description |
|---|---|
--size | Image size (1024x1024, etc.) |
--quality | Image quality (standard, hd) |
--style | Image style (vivid, natural) |
research
Deep research on a topic.| Flag | Description |
|---|---|
--depth | Research depth (iterations) |
--max-sources | Maximum sources to use |
query-rewrite
Rewrite queries for better search results.| Flag | Description |
|---|---|
--strategy | Strategy: expand, simplify, decompose, rephrase, auto |
prompt-expand
Expand prompts with more detail.| Flag | Description |
|---|---|
--strategy | Strategy: detail, context, examples, constraints, auto |
context
Manage conversation context.| Flag | Description |
|---|---|
--max-messages | Maximum messages in context |
router
Route requests to appropriate agents.Safety & Validation
guardrail
Content validation and safety.| Flag | Description |
|---|---|
--criteria | Custom validation criteria |
Memory & State
memory
Manage agent memory.session
Manage agent sessions.knowledge
Manage knowledge base.Tools & Skills
tools
List or manage tools.skills
Manage agent skills.mcp
Model Context Protocol management.Evaluation
eval
Evaluate agent performance.Planning
planning
Task planning and todo management.Infrastructure
vector
Vector store management.- MemoryVectorStore
- PineconeVectorStore
- WeaviateVectorStore
- QdrantVectorStore
- ChromaVectorStore
db
Database adapter management.- SQLite
- Redis (Upstash)
- PostgreSQL (Neon)
- Memory
cache
Caching management.- MemoryCache
- FileCache
graph-rag
Graph-based retrieval augmented generation.reranker
Document reranking.- CohereReranker
- CrossEncoderReranker
- LLMReranker
Monitoring
telemetry
Usage monitoring and analytics.observability
Monitoring and tracing.- ConsoleObservabilityProvider
- MemoryObservabilityProvider
- LangfuseObservabilityProvider
Voice
voice
Text-to-speech and speech-to-text.- OpenAIVoiceProvider
- ElevenLabsVoiceProvider
Agent Handoff
handoff
Agent handoff management.Utility Commands
providers
List available LLM providers.version
Show CLI version.help
Show help information.JSON Output Format
All commands support--json flag for structured output:
Success Response
Error Response
Exit Codes
| Code | Description |
|---|---|
| 0 | Success |
| 1 | Runtime error |
| 2 | Invalid arguments |
| 3 | Config error |
| 4 | Network error |
| 5 | Auth error |
Complete Command List
| Command | Description |
|---|---|
chat | Chat with an AI agent |
run | Run an agent with a task |
workflow | Execute a multi-agent workflow |
auto | Auto-generate agents from topic |
image | Image generation and analysis |
research | Deep research on a topic |
query-rewrite | Rewrite queries for better search |
prompt-expand | Expand prompts with more detail |
context | Manage conversation context |
router | Route requests to agents |
guardrail | Content validation and safety |
memory | Manage agent memory |
session | Manage agent sessions |
knowledge | Manage knowledge base |
tools | List or manage tools |
skills | Manage agent skills |
mcp | Model Context Protocol management |
eval | Evaluate agent performance |
planning | Task planning and todo management |
vector | Vector store management |
db | Database adapter management |
cache | Caching management |
graph-rag | Graph-based RAG |
reranker | Document reranking |
telemetry | Usage monitoring |
observability | Monitoring and tracing |
voice | Text-to-speech and speech-to-text |
handoff | Agent handoff management |
providers | List LLM providers |
version | Show CLI version |
help | Show help information |

