[![Build Status](https://github.com/apowers313/pupt/workflows/CI/badge.svg)](https://github.com/apowers313/pupt/actions)
[![npm version](https://badge.fury.io/js/pupt.svg)](https://www.npmjs.com/package/pupt)
[![Documentation](https://img.shields.io/badge/docs-view-blue)](https://apowers313.github.io/pupt/)
[![Coverage Status](https://coveralls.io/repos/github/apowers313/pupt/badge.svg?branch=master)](https://coveralls.io/github/apowers313/pupt?branch=master)

# PUPT (Powerful Universal Prompt Tool)

<div align="center">
  <img src="./assets/pupt.png" alt="PUPT Logo" width="200">
  
  # PUPT
  **Your Faithful Prompt Companion**
</div>

A powerful CLI tool for managing and using AI prompts with template support, designed to be your faithful prompt companion.

## Features

- ✏️ **Prompt Management** - Create, edit, and organize prompts easily
- 📝 **Template Support** - Use Handlebars templates with user input
- 🔍 **Interactive Search** - Quickly find prompts with fuzzy search
- 🔧 **Cross-platform** - Works on Windows, macOS, and Linux
- 🚀 **Tool Integration** - Run prompts with Claude Code, Kiro, or any command line tool
- 📊 **History Tracking** - Keep track of generated prompts and re-run them
- 📊 **Output Capture** - Capture and save command outputs (configurable)
- 🏷️ **Annotations** - Add notes and tags to your prompt history
- 🤖 **Auto-annotation** - Automatically analyze and annotate prompt executions
- 📋 **Review Command** - Analyze prompt usage patterns and generate improvement suggestions
- 📦 **Install Prompts** - Install and share prompts from git or npm

## Quick Start

```bash
# Install globally
npm install -g pupt

# Initialize configuration
pt init

# Create your first prompt
pt add

# Run the tool
pt
```

## Documentation

For comprehensive documentation, tutorials, and examples, visit our documentation site:

**📚 [View Full Documentation](https://apowers313.github.io/pupt/)**

The documentation includes:
- **[Getting Started Guide](https://apowers313.github.io/pupt/guide/getting-started)** - Installation and first steps
- **[Prompt Templates](https://apowers313.github.io/pupt/guide/prompt-templates)** - Learn how to create dynamic prompts
- **[Command Reference](https://apowers313.github.io/pupt/commands/)** - Detailed information on all commands
- **[Configuration Guide](https://apowers313.github.io/pupt/guide/configuration)** - Customize PUPT to your needs
- **[Available Prompts](https://apowers313.github.io/pupt/prompts)** - Browse built-in prompt templates
- **[Troubleshooting](https://apowers313.github.io/pupt/guide/troubleshooting)** - Solutions to common issues
- **[Development Guide](https://apowers313.github.io/pupt/guide/development)** - Contributing and building from source

## Repository

- **GitHub**: [https://github.com/apowers313/pupt](https://github.com/apowers313/pupt)
- **Issues**: [https://github.com/apowers313/pupt/issues](https://github.com/apowers313/pupt/issues)
- **Author**: Adam Powers <apowers@ato.ms>

## License

MIT