Prompd Documentation

Official documentation for the Prompd ecosystem — structured, composable prompt engineering for AI workflows.

Prompd treats prompts as versioned software artifacts with typed parameters, inheritance, and a package registry. These docs cover the file format, CLI usage, registry API, and composition system.

Getting Started

1. Install the CLI: pip install prompd
2. Read the format spec: FORMAT.md — how .prmd files work
3. Try the examples: see Examples below

Core Documentation

Document	Description
Format Spec	.prmd file format — YAML frontmatter + Markdown content
CLI Reference	Command reference for the Prompd CLI
Inheritance	Template inheritance and composition system
Registry	Registry API and package publishing
Ecosystem	Overview of the Prompd platform
Packages	Package format and distribution

Examples

• Prompts: ./examples/prompds/ — sample .prmd files
• Parameters: ./examples/params/ — example parameter files
• Run script: ./examples/run-get-user-info.sh

# Validate an example prompt
prompd validate ./examples/prompds/get-user-info-extended.prmd

# Compile to Markdown
prompd compile ./examples/prompds/get-user-info-extended.prmd --to-markdown

# Run with parameters
prompd run ./examples/prompds/get-user-info-extended.prmd \
  --params-file ./examples/params/get-user-info.json

Related

• Prompd CLI — CLI tools (Python, Go, Node.js)
• Prompd App — Desktop IDE
• Prompd API — API integration packages
• Community Prompts — Example packages and templates
• PrompdHub — Package registry

License

Elastic License 2.0 (ELv2) — see LICENSE for details.