Skip to content
prompd
GitHub

Getting Started

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

Installation

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


# Verify installation
prompd --version

Python CLI

Section titled “Python CLI”

The Python implementation includes full MCP support and asset extraction capabilities.

Terminal window
# Install globally via pip
pip install prompd


# Verify installation
prompd --version

Prompd Desktop

Section titled “Prompd Desktop”

Visual IDE for AI workflows with Monaco editor, drag-and-drop workflow canvas, and built-in execution engine.

macOS / Linux

Coming soon

Quick Start

Section titled “Quick Start”

Create Your First Prompt

Section titled “Create Your First Prompt”
Terminal window
# 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

Section titled “Compile Your Prompt”
Terminal window
# 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

Section titled “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

Section titled “Publishing to Registry”
Terminal window
# Package your prompt
prompd package create . my-package.pdpkg


# Login to registry
prompd login


# Publish to registry
prompd publish my-package.pdpkg

Installing Packages

Section titled “Installing Packages”
Terminal window
# 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

Section titled “Next Steps”