Skip to main content
PraisonAI CLI provides a simple way to interact with AI agents directly from your terminal. You can run quick commands, specify LLM options, or use YAML configuration files for more complex scenarios.
PraisonAI CLI Demo

​
Quick Start

1

Install Package

Install the PraisonAI package:
pip install praisonai
2

Set API Key

Set your OpenAI API key as an environment variable:
export OPENAI_API_KEY=your_api_key_here

​
Usage Examples

Simple Command

Run a simple command directly:
praisonai "write a movie script in 3 lines"

With LLM Option

Specify a different LLM model:
praisonai "write a movie script in 3 lines" --llm gpt-4o-mini

Using YAML Config

Run agents defined in a YAML file:
praisonai agents.yaml

​
Configuration

Initialize a new agents.yaml file for your project:
praisonai --init "Create a movie script about AI"
This will create an agents.yaml file with predefined configuration for your task.

​
Features

Simple Commands

Run AI tasks directly from your terminal with simple commands.

LLM Options

Choose from different LLM models for your specific needs.

YAML Support

Use YAML files for complex agent configurations and workflows.

Auto Configuration

Automatic agent setup based on task requirements.

​
Workflow CLI

Manage and execute YAML workflows directly from the command line: 
# Run a YAML workflow
praisonai workflow run research.yaml

# Run with variables
praisonai workflow run research.yaml --var topic="AI trends"

# Validate a workflow
praisonai workflow validate research.yaml

# Create from template (simple, routing, parallel, loop)
praisonai workflow template routing --output my_workflow.yaml

# Auto-generate a workflow from topic
praisonai workflow auto "Research AI trends" --pattern parallel

# List available workflows
praisonai workflow list

# Show help
praisonai workflow help

​
Workflow CLI Options

FlagDescription
--var key=valueSet variable for YAML workflows
--pattern <pattern>Pattern for auto-generation (sequential, parallel, routing, loop)
--output <file>Output file for templates/auto-generation
--planningEnable planning mode
--reasoningEnable reasoning mode
--verboseEnable verbose output
--saveSave output to file

​
Next Steps

YAML Workflows

Learn about YAML workflow configuration and patterns

Workflow Patterns

Explore routing, parallel, loop, and repeat patterns

API Reference

View the complete API documentation