Deploy CLI - PraisonAI Documentation

Deploy agents to API servers, Docker containers, or cloud providers using praisonai deploy.

Quick Start

pip install praisonai
export OPENAI_API_KEY="your-key"

# Initialize deploy config
praisonai deploy init --file agents.yaml --type api

# Deploy
praisonai deploy run --file agents.yaml

Subcommands

Command	Description
`praisonai deploy run`	Execute deployment
`praisonai deploy init`	Generate sample agents.yaml with deploy config
`praisonai deploy validate`	Validate agents.yaml deploy configuration
`praisonai deploy plan`	Show deployment plan without executing
`praisonai deploy doctor`	Check deployment readiness
`praisonai deploy status`	Show deployment status
`praisonai deploy destroy`	Destroy/delete deployment

Deploy Types

Type	Description	Page
`api`	Local API server	API Deploy
`docker`	Docker container	Docker Deploy
`cloud`	Cloud providers (AWS, Azure, GCP)	AWS, Azure, GCP

praisonai deploy run

praisonai deploy run [OPTIONS]

Flag	Type	Default	Description
`--file`, `-f`	string	`agents.yaml`	Path to agents.yaml
`--type`	choice	from YAML	`api`, `docker`, or `cloud`
`--provider`	choice	from YAML	`aws`, `azure`, or `gcp` (for cloud type)
`--background`	flag	false	Run in background (API only)
`--json`	flag	false	Output as JSON

praisonai deploy init

Generate sample agents.yaml with deploy configuration.

praisonai deploy init --file agents.yaml --type api
praisonai deploy init --file agents.yaml --type docker
praisonai deploy init --file agents.yaml --type cloud --provider aws

Flag	Type	Default	Description
`--file`, `-f`	string	`agents.yaml`	Output file path
`--type`	choice	`api`	`api`, `docker`, or `cloud`
`--provider`	choice	-	`aws`, `azure`, or `gcp` (for cloud type)

praisonai deploy validate

Validate agents.yaml deploy configuration.

praisonai deploy validate --file agents.yaml

Expected Output:

🔍 Validating agents.yaml...

✅ Configuration is valid!

Deploy Type: api
  Host: 127.0.0.1
  Port: 8005
  Workers: 1

praisonai deploy plan

Show deployment plan without executing.

praisonai deploy plan --file agents.yaml

Expected Output:

📋 Generating deployment plan...

╭──────────────────────────────────────────────────────────────────────────────╮
│                              Deployment Plan                                  │
│                                                                              │
│ type: api                                                                    │
│ host: 127.0.0.1                                                              │
│ port: 8005                                                                   │
│                                                                              │
│ Steps:                                                                       │
│   1. Load agents from agents.yaml                                            │
│   2. Start API server on 127.0.0.1:8005                                      │
│   3. Register agent endpoints                                                │
╰──────────────────────────────────────────────────────────────────────────────╯

To execute this plan, run:
  praisonai deploy run --file agents.yaml

agents.yaml Deploy Section

Add a deploy section to your agents.yaml:

framework: praisonai
topic: helpful assistant
roles:
  assistant:
    role: Assistant
    goal: Help users
    backstory: You are helpful
    tasks:
      help_task:
        description: Answer questions
        expected_output: Helpful response

deploy:
  type: api
  api:
    host: "127.0.0.1"
    port: 8005
    workers: 1

Deploy Configuration Options

API Config

deploy:
  type: api
  api:
    host: "127.0.0.1"
    port: 8005
    workers: 1
    cors_enabled: true
    auth_enabled: false
    reload: false

Docker Config

deploy:
  type: docker
  docker:
    image_name: "praisonai-app"
    tag: "latest"
    base_image: "python:3.11-slim"
    expose: [8005]
    push: false

Cloud Config (AWS)

deploy:
  type: cloud
  cloud:
    provider: aws
    region: "us-east-1"
    service_name: "praisonai-service"
    cpu: "256"
    memory: "512"
    min_instances: 1
    max_instances: 10

Troubleshooting

Issue	Fix
No deploy section	Run `praisonai deploy init`
Invalid config	Run `praisonai deploy validate`
Missing deps	Run `praisonai deploy doctor`
Deploy failed	Check `praisonai deploy status`

API Deploy - Deploy as local API server
Docker Deploy - Deploy to Docker
AWS Deploy - Deploy to AWS
Doctor - Check deployment readiness

Deploy

​Quick Start

​Subcommands

​Deploy Types

​praisonai deploy run

​praisonai deploy init

​praisonai deploy validate

​praisonai deploy plan

​agents.yaml Deploy Section

​Deploy Configuration Options

​API Config

​Docker Config

​Cloud Config (AWS)

​Troubleshooting

​Related