Registry

List recipes and manage the local recipe registry

The registry command lists recipes and manages the local recipe registry server.

Diagram

⌨️ praisonai registry

📋 list

🚀 serve
⚠ deprecated

💚 status

📁 Local recipes

🌐 HTTP server
:7777

✅ Health check

An agent selects a recipe from the same local registry the CLI enumerates:

python
from praisonaiagents import Agent
from praisonai.recipe.registry import get_registry

registry = get_registry()
recipes = registry.list_recipes(tags=["support"])

agent = Agent(
    name="Support Bot",
    instructions=f"Load {recipes[0]['name']} and handle the ticket.",
)
agent.start("Customer needs a refund for order #4821.")
bash
# The user (or an operator) discovers what's available from the CLI.
praisonai registry list --tags support --json

Quick Start

  1. List recipes

    List every recipe in the local registry (~/.praison/registry):

    bash
    praisonai registry list

    An empty registry prints No recipes found in registry: <path> and still exits 0.

  2. Check server status

    Confirm a running registry server is healthy:

    bash
    praisonai registry status

Commands

list

List recipes in the local recipe registry.

OptionTypeDefaultDescription
--dir PATHstring~/.praison/registryRegistry directory
--tags a,bcomma-separatedNone (no filter)Filter recipes by tags (any-match)
--jsonflagFalseOutput in JSON format

Examples:

bash
# List all local recipes
praisonai registry list

# Filter by tags (matches audio OR video)
praisonai registry list --tags audio,video

# JSON output for scripts
praisonai registry list --json

# List from a custom registry directory
praisonai registry list --dir /shared/recipes

JSON output uses a consistent envelope:

json
{ "ok": true, "registry_path": "...", "count": 2, "recipes": [] }

serve

Start a local HTTP registry server.

OptionTypeDefaultDescription
--port, -pint7777Port to bind to
--hoststring127.0.0.1Host to bind to
--dirstring~/.praison/registryRegistry directory
--tokenstringNoneRequire token for write operations
--read-onlyflagFalseDisable all write operations
--jsonflagFalsePrint startup message as JSON

Examples:

bash
# Deprecated form (prints a warning, then serves)
praisonai registry serve --port 7777

# Canonical form — migrate to this
praisonai serve registry --port 7777
Diagram
HTTP server :7777praisonai serve registrypraisonai registry serveUserHTTP server :7777praisonai serve registrypraisonai registry serveUserSame server, same port,same behaviour — migrateto remove the warning.praisonai registry serve –port 7777⚠ Deprecation warning (stderr)Dispatch to wrapper handlerStart on :7777

status

Check the health of a running registry server.

OptionTypeDefaultDescription
--registry URLstringhttp://localhost:7777Registry URL to check
--jsonflagFalseOutput in JSON format

Examples:

bash
# Check the default registry
praisonai registry status

# Check a specific registry
praisonai registry status --registry http://localhost:7777

# JSON output
praisonai registry status --json

Exit Codes

CodeMeaning
0Success (includes empty registry)
1General error (exception during list)
2Validation error (unknown subcommand)
9Auth error (reserved)
10Network error (cannot connect — used by status)

See Also