Getting Started

Install prompd and create your first composable AI prompt in minutes.

Installation

Python CLI (Recommended)

The Python implementation is the most feature-complete with full MCP support and asset extraction capabilities.

# Install globally via pip
pip install prompd

# Verify installation
prompd --version

Install from source: Clone the repository and install with development dependencies.

git clone https://github.com/Prompd/prompd-cli
cd prompd-cli/cli/python
pip install -e ".[dev,mcp]"

Node.js CLI - Coming Soon

Perfect for JavaScript/TypeScript projects and developer tools.

# Coming Soon
npm install -g @prompd/cli

Go CLI - Coming Soon

Zero-dependency, single binary implementation. Perfect for deployment and CI/CD pipelines.

# Coming Soon
go install github.com/Prompd/prompd-cli/cli/go/cmd/prompd@latest

prompd.app (Electron IDE)

Professional visual IDE with Monaco editor, workflow builders, and integrated package management.

Windows

prompd-app-setup-x64.exe

Coming Soon

macOS

prompd-app-x64.dmg

Coming Soon

Linux

prompd-app-x64.AppImage

Coming Soon

Quick Start

Create Your First Prompt

# Initialize current folder with example.prmd and manifest.json
prompd init .

# Open in your editor
code example.prmd

A basic .prmd file looks like this:

---
id: code-reviewer
name: Code Reviewer
version: 1.0.0
description: Review code for best practices
parameters:
  - name: language
    type: string
    required: true
  - name: code
    type: string
    required: true
---

# System
You are an expert code reviewer specializing in {language}.

# User
Please review the following code:

```{language}
{code}
```

Compile Your Prompt

# Compile to markdown
prompd compile my-prompt.prmd --to-markdown

# Compile to OpenAI JSON format
prompd compile my-prompt.prmd --to-openai-json

# Run with parameters
prompd run my-prompt.prmd --param language="Python" --param code="def hello(): print('world')"

Using Package Inheritance

Build on existing prompts from the registry:

---
id: advanced-reviewer
name: Advanced Reviewer
inherits: "@prompd.io/code-reviewer@1.0.0"
parameters:
  - name: strictness
    type: string
    default: "moderate"
---

# System
Apply {strictness} strictness level to the review.

Publishing to Registry

# Package your prompt
prompd package create . my-package.pdpkg

# Login to registry
prompd login

# Publish to registry
prompd publish my-package.pdpkg

Installing Packages

# Search registry
prompd search "code review"

# Install a package
prompd install @prompd.io/core-patterns@2.0.0

# Run installed package
prompd run @prompd.io/code-reviewer --param language="JavaScript"

Next Steps