PromptKit
Getting Started
Installation
Requirements
Install from PyPI
Development Installation
Verify Installation
Engine Setup
OpenAI
Ollama
Quick Start
Prerequisites
Create a Prompt
Use in Python
Use the CLI
YAML Structure
Template Syntax
Input Types
Next Steps
Creating Your First Prompt
Design
Create the YAML
Use the CLI
Best Practices
Clear Schema
Default Values
Conditional Logic
Tutorials
Advanced Templates
Conditionals
Loops
Filters
Default Values
Macros
Whitespace Control
Error Handling
Input Validation
Basic Types
Optional Fields
Collection Types
Validation Example
Optional Fields
Get Field Info
Examples
Basic Examples
Simple Greeting
Email Generator
Blog Outline
FAQ Response
Advanced Examples
Multi-Step Workflow
Dynamic Templates
Batch Processing
Async Execution
Error Handling
Local Development with Ollama
API Reference
Core API Reference
promptkit.core.prompt
Prompt
Methods
promptkit.core.loader
promptkit.core.runner
promptkit.core.schema
promptkit.core.compiler
PromptCompiler
Engines API Reference
Base Engine
BaseEngine
EngineError
OpenAI Engine
OpenAIEngine
Parameters
Methods
Ollama Engine
OllamaEngine
Parameters
Methods
Creating Custom Engines
CLI Reference
Installation
Commands
run
- Execute a Prompt
render
- Render Template
lint
- Validate Prompt
info
- Prompt Information
cost
- Cost Estimation
Environment Variables
Advanced Topics
Core Concepts
Key Components
Prompts
Engines
Runner
Workflow
Basic Execution
Template Preview
Validation
YAML Format
PromptKit
Index
Index