Skip to content
prompd
GitHub

Prompd CLI

The command-line toolkit for compiling, running, and publishing composable AI prompts. Automate everything from local development to CI/CD.

Installation

Section titled “Installation”
Section titled “Node.js CLI (Recommended)”
Terminal window
npm install -g @prompd/cli

The Node.js CLI is the most feature-complete implementation with full MCP integration, workflow support (.pdflow), and all registry operations.

Python CLI

Section titled “Python CLI”
Terminal window
pip install prompd

The Python CLI supports core .prmd operations and asset extraction. Workflow (.pdflow) support is coming soon.

Quick Start

Section titled “Quick Start”

1. Install the CLI

Section titled “1. Install the CLI”
Terminal window
npm install -g @prompd/cli

2. Create your first .prmd file

Section titled “2. Create your first .prmd file”
Terminal window
prompd init my-prompt

3. Compile the prompt

Section titled “3. Compile the prompt”
Terminal window
prompd compile my-prompt.prmd

4. Run it against a provider

Section titled “4. Run it against a provider”
Terminal window
prompd run my-prompt.prmd --provider openai

Core Commands

Section titled “Core Commands”

prompd compile

Section titled “prompd compile”

Resolve inheritance, inject context, substitute parameters, and output provider-ready prompts.

Terminal window
prompd compile summarizer.prmd --output compiled.json

prompd run

Section titled “prompd run”

Compile and execute a .prmd file against a configured provider in a single step.

Terminal window
prompd run summarizer.prmd --provider openai

prompd validate

Section titled “prompd validate”

Check .prmd files and packages for syntax errors, missing fields, and schema violations.

Terminal window
prompd validate my-prompt.prmd

prompd install

Section titled “prompd install”

Install a package from the registry with automatic dependency resolution.

Terminal window
prompd install @acme/summarizer
Section titled “prompd search”

Search the registry by keyword, namespace, or package type.

Terminal window
prompd search summarizer

prompd publish

Section titled “prompd publish”

Pack and publish your project to the Prompd registry for others to use.

Terminal window
prompd publish --access public

Configuration

Section titled “Configuration”

Providers

Section titled “Providers”

Configure API keys and defaults for OpenAI, Anthropic, and other LLM providers. Switch providers per-prompt or per-project.

Terminal window
prompd config provider add openai --key sk-...

Environment Files

Section titled “Environment Files”

Store secrets in .env files. The CLI automatically loads project-level and global .env on every command.

config.yaml

Section titled “config.yaml”

Project-level configuration for default provider, output format, compilation flags, and registry endpoint.

provider: openai
output: markdown
registry: https://registry.prompdhub.ai

Examples

Section titled “Examples”

Compile with context injection

Section titled “Compile with context injection”

Compile a .prmd file that inherits from a registry package and includes local context files.

Terminal window
prompd compile summarizer.prmd --output compiled.json

Run with parameter overrides

Section titled “Run with parameter overrides”

Execute a prompt with custom parameter values passed from the command line.

Terminal window
prompd run summarizer.prmd -p topic="Kubernetes" -p audience="beginners"

Publish a package

Section titled “Publish a package”

Bundle your project into a .pdpkg archive and publish it to the registry.

Terminal window
prompd publish --access public

Next Steps

Section titled “Next Steps”