Getting Started

Welcome to PUPT (Powerful Universal Prompt Tool) - your faithful prompt companion for managing and using AI prompts with advanced templating capabilities.

What is PUPT?

PUPT is a command-line tool designed to streamline your AI workflow by:

• Managing a library of reusable prompt templates
• Collecting user input dynamically through interactive prompts
• Integrating seamlessly with AI tools like Claude Code, Amazon Q, and others
• Tracking prompt history and analyzing usage patterns
• Sharing prompts across teams and projects

Installation

Install PUPT globally using npm:

npm install -g pupt

Or with yarn:

yarn global add pupt

After installation, the pt command will be available globally.

Quick Start

1. Initialize Your Configuration

Start by running the initialization command:

pt init

This interactive setup will help you configure:

• Prompt directories: Where to store your prompt files
• History tracking: Save executed prompts for future reference
• Annotation support: Add notes and tags to your executions
• Default tool: Your preferred AI tool (Claude, GPT, etc.)

2. Create Your First Prompt

Create a new prompt interactively:

pt add

This will:

1. Ask for a filename (e.g., code-review.md)
2. Collect metadata (title, description, tags)
3. Open your default editor to write the prompt content

Here's a simple example prompt:

---
title: Code Review Assistant
tags: [code, review, analysis]
---

Please review the following code and provide feedback on:
- Code quality and best practices
- Potential bugs or issues
- Performance considerations
- Suggestions for improvement

{{input "code" "Paste the code to review:"}}

3. Use Your Prompt

Run PUPT without arguments to see the interactive prompt selector:

pt

This will:

1. Show a searchable list of all your prompts
2. Let you preview prompt content
3. Collect any required inputs
4. Display the generated prompt

4. Execute with Your AI Tool

To send the prompt directly to your configured AI tool:

pt run

Or specify a different tool:

pt run claude
pt run gpt
pt run code -

Understanding Prompt Files

Prompt files are Markdown files with optional YAML frontmatter. They live in your configured prompt directories and can contain:

Basic Structure

---
title: My Prompt Template
tags: [category, subcategory]
---

Your prompt content here with {{variables}} and {{input "helpers"}}.

Interactive Inputs

PUPT provides several helpers to collect user input:

• {{input "name"}} - Text input
• {{select "name"}} - Single choice selection
• {{multiselect "name"}} - Multiple choice selection
• {{confirm "name"}} - Yes/no question
• {{editor "name"}} - Multi-line text in editor
• {{file "name"}} - File path with tab completion
• {{password "name"}} - Masked password input

System Variables

Access system information in your prompts:

• {{date}} - Current date
• {{time}} - Current time
• {{username}} - System username
• {{cwd}} - Current working directory
• {{uuid}} - Generate a unique ID

Next Steps

Now that you have PUPT installed and configured:

1. Explore Commands: Learn about all available commands
2. Master Templates: Dive deep into the template system
3. Configure PUPT: Customize your configuration
4. Browse Examples: Check out recipes and examples

Getting Help

• Run pt help for general help
• Run pt help <command> for command-specific help
• Visit our GitHub repository for issues and discussions

Welcome to the PUPT community! 🐾