Manage Recipes

Step-by-step guide to updating, editing, and deleting recipes

Update recipe versions, validate changes, and retire old templates safely.

from praisonaiagents import Agent

agent = Agent(name="Recipe Maintainer", instructions="Guide safe recipe updates and rollbacks.")
agent.start("How do I version my recipe changes?")

The user edits agents.yaml, validates the folder, and re-runs the recipe with updated variables.

How It Works

---

How to Update a Recipe

1. Check Current Version

   praisonai recipe info my-recipe
   
2. Edit agents.yaml

   Update the configuration and make changes:

   # agents.yaml
   framework: praisonai
   topic: "{{task}}"
   
   roles:
     agent:
       role: Updated Agent
       goal: Updated goal
       # ... modifications
   
3. Validate Changes

   praisonai recipe validate ./my-recipe
   
4. Test Updated Recipe

   praisonai recipe run ./my-recipe --var task="Test task"
   

How to Edit Recipe Variables

1. View Current Variables

   praisonai recipe info my-recipe
   
2. Use Variables in agents.yaml

   framework: praisonai
   topic: "{{task}}"
   
   roles:
     agent:
       role: "{{role_name}}"
       goal: Complete the task
       tasks:
         main_task:
           description: |
             Task: {{task}}
             Format: {{output_format}}
   
3. Run with Variables

   praisonai recipe run my-recipe --var task="Research AI" --var output_format="markdown"
   

How to Delete a Recipe

1. List Installed Recipes

   praisonai recipe list
   
2. Remove Recipe

   praisonai recipe remove my-recipe
   
3. Verify Removal

   praisonai recipe list
   

Recipe Management Commands

Command	Description
praisonai recipe list	List all recipes
praisonai recipe info <name>	Show recipe details
praisonai recipe validate <path>	Validate recipe
praisonai recipe remove <name>	Remove recipe

Best Practices

Validate after every edit

Run praisonai recipe validate before re-running so a bad change is caught while it is easy to fix.

Track recipes in version control

Commit agents.yaml and tools.py so changes are reviewable and a broken update can be rolled back cleanly.

Confirm removal with list

After praisonai recipe remove, run praisonai recipe list to verify the recipe is gone and no callers still reference it.

---

Related

Debug Recipes

Troubleshoot a failing update

Create Custom Recipes

Author a new recipe