Skip to main content

A CLI tool for managing and using prompt templates with placeholder injection.

Project description

Proplate

A CLI tool for managing and using prompt templates with placeholder injection. Perfect for storing reusable prompt templates and quickly filling them with context-specific information.

Features

  • 🎯 Interactive template selection with fuzzy search
  • Direct template access with tab autocomplete
  • 📋 Auto-copy to clipboard for seamless pasting
  • 🔧 Placeholder support with single-line and multi-line input
  • Default values for placeholders with {{name:default}} syntax
  • 📝 YAML frontmatter for template metadata
  • 🎨 Rich CLI output with beautiful formatting

Installation

pip install proplate

Quick Start

1. Create a template

Easy way:

proplate new code-review

This opens your editor with starter content:

---
title: Code Review
description: Add a description here
---

# {{placeholder}}

Your template content goes here.
Use {{placeholder}} syntax for variables.

Or manually create ~/.proplate/templates/code-review.md:

---
title: Code Review Guide
description: Template for thorough code reviews
---

# Code Review: {{file_path}}

## Context
{{context}}

## Review Areas
{{focus_areas}}

## Security Considerations
{{security_notes}}

Pro tip: Make placeholders self-documenting!

{{Your feature request here. Be specific about WHAT and WHY.}}

This way, the placeholder itself tells users what to enter.

2. Use your template

Interactive mode (with fuzzy search):

proplate

Direct selection (with tab autocomplete):

proplate code-review

The tool will:

  1. Prompt you for each {{placeholder}}
  2. Support multi-line input when needed
  3. Automatically copy the filled template to your clipboard
  4. You can then paste directly into Cursor, ChatGPT, or any other tool

Usage

Main Commands

# Interactive template selector
proplate

# Use a specific template (supports tab completion)
proplate <template-name>

# Create a new template (opens in $EDITOR with starter content)
proplate new <template-name>

# List all available templates
proplate list

# Edit an existing template in $EDITOR
proplate edit <template-name>

# Delete a template (with confirmation)
proplate delete <template-name>

# Delete a template without confirmation
proplate delete <template-name> --force

# Show templates directory path
proplate path

# Initialize templates directory (optional - auto-created on first use)
proplate init

Managing Templates

Create a new template:

proplate new my-template

Creates a template with starter content and opens it in your $EDITOR.

Edit existing template:

proplate edit my-template

Delete a template:

proplate delete my-template        # With confirmation prompt
proplate delete my-template --force # Skip confirmation

Manual way: Create/edit .md files directly in ~/.proplate/templates/ (auto-created on first use)

Shell Autocomplete

Enable tab completion for template names:

# For bash
proplate --install-completion bash

# For zsh
proplate --install-completion zsh

# For fish
proplate --install-completion fish

Then restart your shell or source your config file.

Template Format

Templates are Markdown files with optional YAML frontmatter and {{placeholder}} syntax.

Basic Template

# Hello {{name}}!

This is a simple template.

Template with Frontmatter

---
title: Bug Analysis
description: Structured template for bug investigation
---

# Bug Report: {{bug_id}}

## Description
{{description}}

## Steps to Reproduce
{{steps}}

## Expected vs Actual
**Expected:** {{expected}}
**Actual:** {{actual}}

Placeholder Guidelines

  • Use {{placeholder}} syntax
  • Default values: Use {{placeholder:default value}} to provide fallback values
  • Escape colons: Use \: to include literal colons in names or defaults (e.g., {{url:https\://example.com}})
  • Multi-line editor: Type - to open $EDITOR for multi-line input (works with or without defaults)
  • Placeholders can be descriptive instructions (e.g., {{Your request here. Be specific!}})
  • Support spaces, punctuation, and special characters
  • Duplicate placeholders are prompted once and replaced everywhere
  • Whitespace variations ({{name}}, {{ name }}) are normalized
  • Leave input empty to:
    • Use default value (if defined)
    • Open multi-line editor ($EDITOR) (if no default)

Examples

Example 1: Code Review Template

~/.proplate/templates/code-review.md:

---
title: Code Review
description: Comprehensive code review template
---

# Code Review: {{file_path}}

## Context
{{context}}

## Changes Summary
{{changes}}

## Review Checklist
- [ ] Code quality and readability
- [ ] Error handling
- [ ] Security considerations
- [ ] Performance implications
- [ ] Test coverage

## Specific Feedback
{{feedback}}

Example 2: Feature Request (with Default Values)

~/.proplate/templates/feature-request.md:

---
title: Feature Request
description: Template for proposing new features with sensible defaults
---

# Feature Request: {{feature_name}}

## Priority
{{priority:Medium}}

## Requested By
{{requester:Product Team}}

## Description
{{description}}

## Expected Benefits
{{benefits}}

## Implementation Complexity
{{complexity:To be assessed}}

## Target Release
{{release:Next Quarter}}

Usage: When filling this template, press Enter on prompts with defaults to use them, or type to override.

Example 3: Refactoring Plan

~/.proplate/templates/refactor.md:

---
title: Refactoring Plan
description: Template for planning refactoring work
---

# Refactoring: {{component_name}}

## Current State
{{current_state}}

## Problems
{{problems}}

## Proposed Solution
{{solution}}

## Migration Strategy
{{migration}}

## Risks
{{risks}}

Tips

  1. Default Values: Use {{placeholder:default}} to provide sensible defaults that users can accept with Enter
  2. Multi-line Editor Access:
    • Type - to open $EDITOR for multi-line input (works even with defaults)
    • Or press Enter on placeholders without defaults
  3. Escaping Colons: Use \: when you need literal colons in placeholder names or defaults:
    • URLs: {{api_url:https\://api.example.com}}
    • Times: {{meeting_time:14\:30\:00}}
    • Labels: {{Note\: Important:Remember this}}
  4. Template Organization: Use descriptive filenames (they become the template name)
  5. Metadata: Add title and description in frontmatter for better organization
  6. Separators: Use --- freely in your template body (only the first block is frontmatter)

Development

# Clone repository
git clone <repo-url>
cd proplate

# Install with uv
uv sync

# Run locally
uv run proplate

# Run tests
uv run pytest

# Run specific test
uv run pytest tests/test_template.py -v

Requirements

  • Python >= 3.12
  • Dependencies:
    • typer[all] - CLI framework
    • questionary - Interactive prompts
    • pyperclip - Clipboard operations
    • pyyaml - YAML parsing
    • rich - Terminal formatting

License

MIT

Contributing

Contributions welcome! Please ensure:

  1. Tests pass: pytest
  2. Code follows project style (modern Python 3.12+ syntax)
  3. Add tests for new features

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

proplate-0.2.0.tar.gz (21.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

proplate-0.2.0-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file proplate-0.2.0.tar.gz.

File metadata

  • Download URL: proplate-0.2.0.tar.gz
  • Upload date:
  • Size: 21.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for proplate-0.2.0.tar.gz
Algorithm Hash digest
SHA256 1a4ad09c4f68ee0fd9377cd3b17bdb4ac853c42961ebc94101e5de11501d8e6f
MD5 164cbe799dd6f86f0c94e79327988fe0
BLAKE2b-256 c264350868a1f9671967b312f85ef786c1eb33adc13d5d56f95d1432eeab819f

See more details on using hashes here.

Provenance

The following attestation bundles were made for proplate-0.2.0.tar.gz:

Publisher: release.yml on eliorc/proplate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file proplate-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: proplate-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 11.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for proplate-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d254f4d47e7283f4e3e05d87ddf02601e84f488de03d76c87b46f3b4147f14a7
MD5 882ba6dd6283c7806917acdecde10eb9
BLAKE2b-256 60b692467a851f8743fabf97eabb44c5beb25a8f9c122d711c72950fa64338b5

See more details on using hashes here.

Provenance

The following attestation bundles were made for proplate-0.2.0-py3-none-any.whl:

Publisher: release.yml on eliorc/proplate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page