User Guide

Welcome to the PrompTrek User Guide! This comprehensive documentation will help you master PrompTrek and effectively manage AI editor prompts across your projects.

Getting Started

PrompTrek is a universal AI editor prompt storage solution that allows you to write prompts once and deploy them everywhere. Whether you’re using GitHub Copilot, Cursor, Continue, or any other AI coding assistant, PrompTrek has you covered.

Documentation Sections

Explore the following sections to learn everything about PrompTrek:

📘 UPF Specification

Learn about the Universal Prompt Format (UPF) - the standardized YAML-based format at the heart of PrompTrek. Understand the schema, structure, and how to create your own universal prompts.

⚡ Advanced Features

Discover powerful features like variable substitution and multi-document configurations to create sophisticated prompt setups.

🔌 Editor Adapters

Comprehensive guide to all supported AI editors. Learn how PrompTrek generates editor-specific configurations for GitHub Copilot, Cursor, Continue, Kiro, and more.

📊 Adapter Capabilities

Compare features across different editor adapters. See which advanced features are supported by each AI editor integration.

🔄 Sync Feature

Import existing editor configurations into PrompTrek format, or sync generated editor files back to maintain a single source of truth. Keep your prompts consistent across all tools.

🔗 Pre-commit Integration

Set up automated prompt generation and validation with pre-commit hooks. Ensure your prompts are always up-to-date and valid before committing changes.

Quick Reference

Installation

# Install via pip
pip install promptrek

# Or using uv (recommended for development)
git clone https://github.com/flamingquaks/promptrek.git
cd promptrek
uv sync

Basic Usage

# Interactive mode (recommended for beginners)
promptrek

# Or use traditional CLI commands
# Initialize a new configuration
promptrek init

# Generate for a specific editor
promptrek generate --editor copilot

# Generate for all configured editors
promptrek generate --all

# Validate your configuration
promptrek validate

# Sync from editor-specific files back to UPF
promptrek sync --from copilot

💡 New in v0.6.0: PrompTrek now includes an interactive CLI wizard! Simply run promptrek without arguments to launch the guided interface. Perfect for discovering features without memorizing commands. See the Quick Start Guide for details.

Deprecated Commands

Note: As of schema v3.1.0, the following commands are deprecated:

  • promptrek agents - Use promptrek generate --all instead

Need More Help?

Happy prompting! 🚀