Skip to main content

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.

Agent Recipes CLI Reference

Complete command reference for managing and running Agent Recipes from the command line.

Installation

pip install praisonai agent-recipes

Core Commands

List Recipes

# List all available recipes
praison recipes list

# Output as JSON
praison recipes list --json

# Group by category
praison recipes list --group

Recipe Information

# Show recipe details
praison recipes info ai-blog-generator

# Output as JSON
praison recipes info ai-blog-generator --json

Check Dependencies

# Check if dependencies are satisfied
praison recipes doctor ai-subtitle-generator

# Example output:
# ✓ env:OPENAI_API_KEY
# ✓ package:openai
# ✗ external:ffmpeg
# ✗ tool:whisper_tool

Explain Execution Plan

# Show what a recipe will do
praison recipes explain ai-blog-generator

Initialize Recipe

# Copy recipe to current directory for customization
praison recipes init ai-blog-generator

# Specify output directory
praison recipes init ai-blog-generator --output ./my-recipe

Run Recipe

# Basic run
praison recipes run ai-blog-generator --input "AI in Healthcare"

# With output directory
praison recipes run ai-subtitle-generator video.mp4 --output ./subtitles/

# Dry run (check only, no execution)
praison recipes run ai-video-compressor video.mp4 --dry-run

# Force execution for dry-run-default recipes
praison recipes run ai-data-anonymizer data.csv --write

# With consent flag (for sensitive recipes)
praison recipes run ai-voice-cloner sample.mp3 --consent

Recipe Catalog

Cluster 1: Video & Audio

RecipeDescriptionKey Dependencies
ai-video-highlight-extractorExtract key moments from videosffmpeg, whisper
ai-video-chapter-generatorGenerate YouTube chapterswhisper, LLM
ai-subtitle-generatorGenerate SRT/VTT subtitleswhisper
ai-video-compressorAI-optimized compressionffmpeg
ai-voice-clonerClone voice for TTSopenai
ai-background-music-generatorGenerate royalty-free musicopenai
ai-podcast-transcriberTranscribe with diarizationwhisper
ai-audio-enhancerNoise removal, normalizationffmpeg
Example:
# Generate subtitles
praison recipes run ai-subtitle-generator podcast.mp3 --format srt

# Generate video chapters
praison recipes run ai-video-chapter-generator lecture.mp4

Cluster 2: Documents

RecipeDescriptionKey Dependencies
ai-invoice-processorExtract invoice datatesseract, LLM
ai-resume-parserParse CVs to JSONpdftotext, LLM
ai-contract-analyzerExtract contract termspdftotext, LLM
ai-meeting-summarizerSummarize with action itemswhisper, LLM
ai-slide-generatorGenerate presentationspython-pptx, LLM
ai-ebook-converterConvert to EPUB/MOBIpandoc, calibre
ai-form-fillerAuto-fill PDF formspypdf, LLM
ai-faq-generatorGenerate FAQ from docsLLM
Example:
# Process invoice
praison recipes run ai-invoice-processor receipt.pdf --output invoice.json

# Parse resume
praison recipes run ai-resume-parser cv.pdf --format json

Cluster 3: Images

RecipeDescriptionKey Dependencies
ai-background-removerRemove backgroundsrembg, pillow
ai-image-upscalerAI upscale 2x-8xrealesrgan
ai-watermark-removerRemove watermarksLLM vision
ai-watermark-adderAdd watermarks/logospillow
ai-image-captionerGenerate alt-textLLM vision
ai-color-palette-extractorExtract colorspillow
ai-face-blurBlur faces for privacyopencv
ai-image-taggerAuto-tag imagesLLM vision
Example:
# Remove background
praison recipes run ai-background-remover photo.jpg --output transparent.png

# Generate captions
praison recipes run ai-image-captioner images/ --output captions.json

Cluster 4: Developer Tools

RecipeDescriptionKey Dependencies
ai-commit-message-generatorGenerate commit messagesgit, LLM
ai-code-refactorerRefactor with suggestionsLLM
ai-api-doc-generatorGenerate OpenAPI docsLLM
ai-test-generatorGenerate unit testsLLM
ai-code-reviewerAutomated code reviewgit, LLM
ai-sql-generatorNatural language to SQLLLM
ai-regex-generatorGenerate regex patternsLLM
ai-api-testerAuto-test API endpointsrequests, LLM
Example:
# Generate commit message
praison recipes run ai-commit-message-generator .

# Generate tests
praison recipes run ai-test-generator src/utils.py --output tests/

Cluster 5: Data & Analytics

RecipeDescriptionKey Dependencies
ai-report-generatorGenerate business reportspandas, LLM
ai-chart-generatorGenerate visualizationsmatplotlib, LLM
ai-sentiment-analyzerAnalyze text sentimentLLM
ai-data-anonymizerAnonymize PIIpandas, LLM
ai-log-analyzerAnalyze log patternsLLM
ai-excel-formula-generatorGenerate Excel formulasLLM
ai-etl-pipelineTransform data formatspandas
ai-duplicate-finderFind duplicate fileshashlib, LLM
Example:
# Analyze sentiment
praison recipes run ai-sentiment-analyzer reviews.csv --output analysis.json

# Generate chart
praison recipes run ai-chart-generator sales.csv --type bar --output chart.png

Cluster 6: Web & Content

RecipeDescriptionKey Dependencies
ai-seo-optimizerOptimize for SEOLLM
ai-blog-generatorGenerate blog postsLLM
ai-newsletter-generatorGenerate newslettersLLM
ai-social-media-generatorGenerate social postsLLM
ai-product-description-generatorE-commerce descriptionsLLM
ai-rss-aggregatorAggregate RSS feedsfeedparser, LLM
ai-sitemap-generatorGenerate XML sitemapsrequests
ai-meta-tag-generatorGenerate meta tagsLLM
Example:
# Generate blog post
praison recipes run ai-blog-generator --input "Future of AI"

# Generate social media posts
praison recipes run ai-social-media-generator --input "Product launch announcement"

Cluster 7: Productivity

RecipeDescriptionKey Dependencies
ai-email-parserExtract email dataLLM
ai-calendar-schedulerParse events to iCalLLM
ai-file-organizerAuto-organize filesLLM
ai-note-summarizerSummarize notesLLM
ai-translation-batchBatch translate docsLLM
ai-qr-code-generatorGenerate QR codesqrcode
ai-barcode-scannerScan barcodespyzbar
Example:
# Parse emails
praison recipes run ai-email-parser inbox.eml --output parsed.json

# Generate QR code
praison recipes run ai-qr-code-generator --input "https://example.com"

Common Flags

FlagDescription
--input, -iInput file or value
--output, -oOutput directory
--formatOutput format (json, csv, etc.)
--modelLLM model to use
--providerLLM provider (openai, anthropic, google)
--dry-runCheck dependencies only
--writeExecute (for dry-run-default recipes)
--consentAcknowledge consent requirements
--jsonOutput as JSON

Environment Variables

# Required for most recipes
export OPENAI_API_KEY=sk-...

# Alternative providers
export ANTHROPIC_API_KEY=sk-ant-...
export GOOGLE_API_KEY=AIza...

# Optional
export TAVILY_API_KEY=tvly-...  # For web search recipes

Output Structure

All recipes generate a run.json file with execution metadata:
{
  "recipe": "ai-blog-generator",
  "version": "1.0.0",
  "timestamp": "2024-12-29T12:00:00Z",
  "inputs": {"topic": "AI in Healthcare"},
  "outputs": {"file": "output/blog.md"},
  "status": "success",
  "duration_ms": 3500
}