> ## 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. # Recipe Registry > Publish and pull recipes from local or remote registries # Recipe Registry CLI The recipe registry allows you to publish, pull, and manage recipes in a centralized location. ## Quick Start ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} # Publish a recipe to local registry praisonai recipe publish ./my-recipe # Pull a recipe from registry praisonai recipe pull my-recipe@1.0.0 # List recipes in registry praisonai recipe list ``` ## Commands ### publish Publish a recipe bundle or directory to the registry. ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} praisonai recipe publish [options] ``` **Options:** | Option | Description | | -------------------------- | ------------------------------------------------------ | | `--registry ` | Registry path or URL (default: \~/.praisonai/registry) | | `--token ` | Authentication token for remote registry | | `--force` | Overwrite existing version | | `--json` | Output JSON format | **Examples:** ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} # Publish a bundle praisonai recipe publish my-recipe-1.0.0.praison # Publish a directory (auto-packs) praisonai recipe publish ./my-recipe # Publish to custom registry praisonai recipe publish ./my-recipe --registry /path/to/registry # Force overwrite existing version praisonai recipe publish ./my-recipe --force # JSON output praisonai recipe publish ./my-recipe --json ``` ### pull Pull a recipe from the registry. ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} praisonai recipe pull [@version] [options] ``` **Options:** | Option | Description | | -------------------------- | ----------------------------------- | | `--registry ` | Registry path or URL | | `--token ` | Authentication token | | `-o, --output ` | Output directory (default: current) | | `--json` | Output JSON format | **Examples:** ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} # Pull latest version praisonai recipe pull my-recipe # Pull specific version praisonai recipe pull my-recipe@1.0.0 # Pull to specific directory praisonai recipe pull my-recipe -o ./recipes # Pull from custom registry praisonai recipe pull my-recipe --registry /path/to/registry ``` ## Registry Types ### Local Registry The default registry is stored at `~/.praisonai/registry`. No configuration required. ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} # Uses default local registry praisonai recipe publish ./my-recipe praisonai recipe pull my-recipe ``` ### Custom Local Registry Specify a custom path for the registry: ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} # Use custom path praisonai recipe publish ./my-recipe --registry /shared/recipes praisonai recipe pull my-recipe --registry /shared/recipes ``` ### HTTP Registry Start a local HTTP registry server and connect to it: ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} # Start HTTP registry server praisonai serve registry --port 7777 # Start with authentication required praisonai serve registry --port 7777 --token mysecret # Start in read-only mode praisonai serve registry --port 7777 --read-only ``` Connect to HTTP registry: ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} # Publish to HTTP registry praisonai recipe publish ./my-recipe --registry http://localhost:7777 # Publish with token authentication praisonai recipe publish ./my-recipe \ --registry http://localhost:7777 \ --token $PRAISONAI_REGISTRY_TOKEN # Pull from HTTP registry praisonai recipe pull my-recipe --registry http://localhost:7777 # List recipes from HTTP registry praisonai recipe list --registry http://localhost:7777 # Search HTTP registry praisonai recipe search agent --registry http://localhost:7777 ``` ### Remote HTTPS Registry Connect to remote registries: ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} # Publish to remote registry praisonai recipe publish ./my-recipe \ --registry https://registry.example.com \ --token $REGISTRY_TOKEN # Pull from remote registry praisonai recipe pull my-recipe \ --registry https://registry.example.com ``` ## Registry Server Commands ### serve Start a local HTTP registry server. ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} praisonai serve registry [options] ``` **Options:** | Option | Description | | ----------------- | ---------------------------------------------------- | | `--host ` | Host to bind to (default: 127.0.0.1) | | `--port ` | Port to bind to (default: 7777) | | `--dir ` | Registry directory (default: \~/.praisonai/registry) | | `--token ` | Require token for write operations | | `--read-only` | Disable all write operations | | `--json` | Output in JSON format | **Examples:** ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} # Start on default port praisonai serve registry # Start on custom port praisonai serve registry --port 8080 # Start with authentication praisonai serve registry --token mysecrettoken # Start with custom directory praisonai serve registry --dir /path/to/registry # Start in read-only mode (no publish/delete) praisonai serve registry --read-only ``` ### status Check registry server health. ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} praisonai registry status [options] ``` **Options:** | Option | Description | | ------------------ | ---------------------------------------------------------------------- | | `--registry ` | Registry URL (default: [http://localhost:7777](http://localhost:7777)) | | `--json` | Output in JSON format | **Examples:** ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} # Check default registry praisonai registry status # Check specific registry praisonai registry status --registry http://localhost:8080 # JSON output praisonai registry status --json ``` ## HTTP API Endpoints When running `praisonai serve registry`, the following endpoints are available: | Method | Endpoint | Description | | ------ | --------------------------------------- | ------------------------------ | | GET | `/healthz` | Health check | | GET | `/v1/recipes` | List all recipes | | GET | `/v1/recipes/{name}` | Get recipe info | | GET | `/v1/recipes/{name}/{version}` | Get version info | | GET | `/v1/recipes/{name}/{version}/download` | Download bundle | | POST | `/v1/recipes/{name}/{version}` | Publish bundle (auth required) | | DELETE | `/v1/recipes/{name}/{version}` | Delete version (auth required) | | GET | `/v1/search?q=...` | Search recipes | ## Registry Structure ``` ~/.praisonai/registry/ ├── index.json # Recipe index └── recipes/ └── my-recipe/ └── 1.0.0/ ├── manifest.json └── my-recipe-1.0.0.praison ``` ## Environment Variables | Variable | Description | | -------------------------- | ---------------------------- | | `PRAISONAI_REGISTRY_TOKEN` | Default authentication token | ## Exit Codes | Code | Meaning | | ---- | --------------------------------- | | 0 | Success | | 2 | Validation error (invalid bundle) | | 7 | Recipe not found | ## Python API ```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}} from praisonai.recipe.registry import LocalRegistry, get_registry # Create registry registry = LocalRegistry() # Uses default path # or registry = LocalRegistry("/custom/path") # Publish result = registry.publish("my-recipe-1.0.0.praison") print(f"Published: {result['name']}@{result['version']}") # Pull result = registry.pull("my-recipe", version="1.0.0", output_dir="./recipes") print(f"Pulled to: {result['path']}") # List recipes = registry.list_recipes() for r in recipes: print(f"{r['name']} ({r['version']})") # Search results = registry.search("hello") ``` ## Next Steps * [Run History](/docs/cli/recipe-runs) - Store and export run history * [Security Features](/docs/cli/recipe-security) - SBOM, signing, auditing * [Policy Packs](/docs/cli/recipe-policy) - Manage tool permissions