prpm 1.2.1 → 2.0.1

package/README.md

@@ -1,928 +1,156 @@
-# PRPM CLI - Prompt Package Manager
+<p align="center">
+  <img src="https://raw.githubusercontent.com/pr-pm/prpm/main/packages/webapp/public/logo.svg" alt="PRPM Logo" width="200" />
+</p>
 
-A comprehensive CLI tool for managing AI prompt packages across multiple platforms (Cursor, Claude, Continue, Windsurf).
+# PRPM - The Package Manager for AI Prompts
 
-## Installation
+The universal registry for AI coding tools.
 
-### NPM (Recommended)
-```bash
-npm install -g prpm
-```
-
-### Homebrew (macOS)
-```bash
-# Direct installation (recommended)
-brew install khaliqgant/homebrew-prpm/prpm
-
-# Or manual tap installation
-brew tap khaliqgant/homebrew-prpm
-brew install prpm
-```
-
-### Direct Download
-Download the latest binary from [GitHub Releases](https://github.com/pr-pm/prpm/releases).
-
-## Quick Start
-
-```bash
-# Search for packages
-prpm search react
-
-# Install a package from the registry
-prpm install react-rules
-
-# Add a package from a URL
-prpm add https://raw.githubusercontent.com/user/repo/main/rules.md --as cursor
-
-# List installed packages
-prpm list
-
-# Check for updates
-prpm outdated
-```
-
-## Commands
-
-### Package Management
-
-#### `prpm install <package>`
-
-Install a package from the PRPM registry.
-
-```bash
-# Install latest version
-prpm install react-rules
-
-# Install specific version
-prpm install react-rules@1.2.0
-
-# Install with custom format
-prpm install react-rules --as claude
-
-# Install with frozen lockfile (CI mode)
-prpm install react-rules --frozen-lockfile
-```
-
-**Options:**
-- `--version <version>` - Specific version to install
-- `--type <type>` - Override package type (cursor, claude, continue, windsurf, generic)
-- `--as <format>` - Download in specific format (cursor, claude, continue, windsurf, canonical)
-- `--frozen-lockfile` - Fail if lock file needs to be updated (for CI)
-
-**Examples:**
-```bash
-# Install for Claude
-prpm install typescript-rules --as claude
-
-# Install specific version
-prpm install typescript-rules --version 2.1.0
-
-# CI mode with frozen lockfile
-prpm install typescript-rules --frozen-lockfile
-```
-
----
-
-#### `prpm add <url>`
-
-Add a package directly from a raw GitHub URL.
+Discover and install cross-platform prompts, rules, skills, and agents that work with Cursor, Claude, Continue, Windsurf, GitHub Copilot, OpenAI Codex, Google Gemini, Kiro, and more — all from one file.
 
 ```bash
-# Add a Cursor rule
-prpm add https://raw.githubusercontent.com/user/repo/main/rules.md --as cursor
-
-# Add a Claude agent
-prpm add https://raw.githubusercontent.com/user/repo/main/agent.md --as claude
-```
-
-**Options:**
-- `--as <type>` - Package type (cursor or claude), default: cursor
-
-**Examples:**
-```bash
-# Add from GitHub
-prpm add https://raw.githubusercontent.com/acme/rules/main/cursor-rules.md --as cursor
-
-# Add from custom URL
-prpm add https://example.com/my-rules.md --as claude
-```
-
----
-
-#### `prpm uninstall <id>`
-
-Remove an installed package.
-
-```bash
-prpm uninstall react-rules
+npm install -g prpm
+prpm install collections/nextjs-pro  # Entire Next.js setup in one command
 ```
+Installs 20 packages: backend-architect, cloud-architect, database-architect, and more
 
-**Examples:**
-```bash
-# Remove by package ID
-prpm uninstall typescript-rules
+7,5000+ cross platform packages
 
-# Remove cursor rules
-prpm uninstall cursor-rules
-```
+[Docs](https://docs.prpm.dev) | [Search Packages](https://prpm.dev/search) | [Search Collections](https://prpm.dev/search?tab=collections)
 
 ---
 
-#### `prpm list`
-
-List all installed packages.
-
-```bash
-prpm list
-```
-
-Displays a formatted table showing:
-- Package ID
-- Package type
-- Source URL
-- Installation path
+![demo](https://raw.githubusercontent.com/pr-pm/prpm/main/packages/webapp/public/demo.gif)
 
-**Example output:**
-```
-ID              TYPE    URL                                          DESTINATION
-react-rules     cursor  https://registry.prpm.dev/...            .cursor/rules/react-rules.md
-typescript-best claude  https://registry.prpm.dev/...            .claude/agents/typescript-best.md
-
-Total: 2 packages
-```
+## Self Improve
+Give your IDE the ability to self improve by installing packages that it finds useful:
+![self-improve-demo](https://raw.githubusercontent.com/pr-pm/prpm/main/packages/webapp/public/self-improve.gif)
 
 ---
 
-#### `prpm index`
+## Universal Packages - Install Once, Use Anywhere
 
-Scan existing `.cursor/rules/` and `.claude/agents/` directories and register any unregistered files.
+Every package works in **any** AI editor. No conversion tools, no separate downloads:
 
 ```bash
-prpm index
+# Same package, different editors
+prpm install @sanjeed5/react --as cursor                    # → .cursor/rules/
+prpm install @sanjeed5/react --as claude --subtype agent    # → .claude/agents/
+prpm install @sanjeed5/react --as continue                  # → .continue/prompts/
+prpm install @sanjeed5/react --as windsurf                  # → .windsurf/rules/
+prpm install @sanjeed5/react --as copilot                   # → .github/instructions/
+prpm install @sanjeed5/react --as kiro                      # → .kiro/steering/
 ```
 
-This is useful when:
-- You have existing prompt files in your project
-- You want to import files into PRPM tracking
-- You manually copied files and want them registered
+## Discovery - Find What You Need
 
-**Example output:**
-```
-Found 3 files in .cursor/rules/
-  Added: cursor-rules.md (cursor-rules)
-  Skipped: existing-rules.md (already registered)
-
-Found 1 file in .claude/agents/
-  Added: agent.md (agent)
+Browse packages with powerful discovery:
 
-Summary: 2 new packages added, 1 already registered
-```
-
----
-
-### Discovery & Search
-
-#### `prpm search <query>`
-
-Search for packages in the registry.
-
-```bash
-# Basic search
-prpm search react
-
-# Filter by type
-prpm search typescript --type cursor
-
-# Limit results
-prpm search coding --limit 10
-```
-
-**Options:**
-- `--type <type>` - Filter by package type (cursor, claude, continue, windsurf, generic)
-- `--limit <number>` - Number of results to show (default: 20)
-
-**Examples:**
 ```bash
-# Search for React-related packages
+# Search by keyword
 prpm search react
+prpm search "test driven development"
 
-# Find Cursor-specific packages
-prpm search javascript --type cursor
-
-# Get top 5 results
-prpm search best-practices --limit 5
-```
-
----
-
-#### `prpm trending`
-
-Show trending packages from the last 7 days.
-
-```bash
-# Show trending packages
+# See what's trending
 prpm trending
 
-# Filter by type
-prpm trending --type cursor
-
-# Show more results
-prpm trending --limit 20
-```
+# Get detailed info
+prpm info @username/react-best-practices
+# → Shows: description, downloads, rating, tags, installation instructions
 
-**Options:**
-- `--type <type>` - Filter by package type (cursor, claude, continue, windsurf, generic)
-- `--limit <number>` - Number of packages to show (default: 10)
-
-**Examples:**
-```bash
-# Top 10 trending packages
-prpm trending
-
-# Trending Claude packages
-prpm trending --type claude
-
-# Top 5 trending
-prpm trending --limit 5
-```
-
----
-
-#### `prpm popular`
-
-Show all-time popular packages.
-
-```bash
-# Show popular packages
-prpm popular
-
-# Filter by type
-prpm popular --type cursor
-```
-
-**Options:**
-- `-t, --type <type>` - Filter by package type (cursor, claude, continue, windsurf)
-
-**Examples:**
-```bash
-# Most popular packages
-prpm popular
-
-# Popular Cursor packages
-prpm popular --type cursor
-```
-
----
-
-#### `prpm info <package>`
-
-Display detailed information about a package.
-
-```bash
-prpm info react-rules
-```
-
-Shows:
-- Package name and description
-- Download statistics
-- Rating
-- Latest version
-- Tags and categories
-- Installation instructions
-
-**Example output:**
-```
-React Development Rules ✓ Verified
-
-A comprehensive set of React best practices and rules.
-
-Stats:
-   Downloads: 12,543
-   Rating: ★★★★★ (4.8/5)
-
-Latest Version: 2.1.0
-
-Tags: react, javascript, best-practices
-
-Installation:
-   prpm install react-rules
-   prpm install react-rules@2.1.0
-```
-
----
-
-### Collections
-
-#### `prpm collections` / `prpm collections list`
-
-List available package collections.
-
-```bash
-# List all collections
+# Browse collections
 prpm collections
-
-# Filter by category
-prpm collections list --category frontend
-
-# Show only official collections
-prpm collections list --official
-
-# Filter by scope
-prpm collections list --scope prpm
+prpm collections search frontend
+prpm collections info collection/nextjs-pro
 ```
 
-**Options:**
-- `--category <category>` - Filter by category
-- `--tag <tag>` - Filter by tag
-- `--official` - Show only official collections
-- `--scope <scope>` - Filter by scope
-
-**Examples:**
-```bash
-# View all collections
-prpm collections
-
-# Official collections only
-prpm collections list --official
-
-# Frontend-related collections
-prpm collections list --category frontend
-```
+[CLI Reference](https://docs.prpm.dev/cli/overview)
 
 ---
 
-#### `prpm collections info <collection>`
+## Playground
 
-Show detailed information about a collection.
+Test packages interactively before installing:
 
 ```bash
-# View collection details
-prpm collections info @prpm/react-starter
-
-# View specific version
-prpm collections info @prpm/react-starter@1.0.0
-```
+# Try a package in the browser playground
+prpm playground --package @username/react-best-practices
 
-Shows:
-- Collection description
-- Statistics (downloads, stars)
-- Included packages (required and optional)
-- Installation instructions
-
-**Example output:**
+# Test with different AI models
+# → Opens browser playground at prpm.dev/playground
+# → Select model: Claude 3.5 Sonnet, GPT-4, etc.
+# → Test prompt with sample code
+# → See results before installing
 ```
-React Starter Kit
-==================
-
-A curated collection of React development packages.
-
-Stats:
-   Downloads: 5,432
-   Stars: 234
-   Version: 1.0.0
-   Packages: 5
 
-Included Packages:
-   Required:
-   1. ✓ react-rules@2.1.0
-      Best practices for React development
+**Features:**
+-  **Multi-Model Testing** - Try packages with Claude, GPT-4, and more
+-  **Free Credits** - 1,000 monthly credits for all logged in users
+-  **Live Results** - See how prompts perform in real-time
+-  **Save Sessions** - Resume testing later
+-  **Compare Models** - Test same prompt across different AI models
 
-   Optional:
-   1. ○ typescript-rules@1.0.0
-      TypeScript configuration for React
+**[Try Playground →](https://prpm.dev/playground)**
 
-Install:
-   prpm install @prpm/react-starter
-```
-
----
-
-### Updates & Upgrades
-
-#### `prpm outdated`
-
-Check for package updates.
+## Why PRPM?
 
+### The Problem
 ```bash
-prpm outdated
+# Current workflow (painful)
+1. Find cursor rule on GitHub
+2. Copy raw file URL
+3. Create .cursor/rules/something.md
+4. Paste content
+5. Repeat for every rule
+6. Update manually when rules change
+7. Do it all again for Claude/Continue/Windsurf
 ```
 
-Shows which packages have updates available, grouped by:
-- Major updates (breaking changes possible)
-- Minor updates (new features)
-- Patch updates (bug fixes)
+### Team Consistency
 
-**Example output:**
-```
-Major Updates (breaking changes possible):
-   react-rules                    1.0.0 → 2.0.0
+If you're working on a big project and some coworkers use Copilot, others use Claude, and sometimes it's Cursor, the only way to unify rules so it's consistent across the codebase is to use PRPM. It's an easy way to make sure everyone has the same rules across the team.
 
-Minor Updates (new features):
-   typescript-rules               1.0.0 → 1.1.0
+## For Package Authors
 
-Patch Updates (bug fixes):
-   eslint-config                  1.0.0 → 1.0.1
+### Share Your Packages
 
-Run "prpm update" to update to latest minor/patch versions
-Run "prpm upgrade" to upgrade to latest major versions
-```
+Package authors can publish to PRPM and reach users across all editors.
 
----
-
-#### `prpm update [package]`
-
-Update packages to latest compatible versions (minor/patch only, skips major versions).
+**How it works:**
+- Authors publish in canonical format
+- PRPM converts to all editor formats automatically
+- Users install in their preferred editor
 
-```bash
-# Update all packages
-prpm update
-
-# Update specific package
-prpm update react-rules
-```
-
-**Options:**
-- `--all` - Update all packages
-
-**Examples:**
-```bash
-# Update all packages (safe updates only)
-prpm update
-
-# Update specific package
-prpm update typescript-rules
-```
+**Benefits:**
+- At least 4x reach (Cursor + Claude + Continue + Windsurf users, + more)
+- One package, works everywhere
+- Version control and updates
+- Download analytics
 
 ---
 
-#### `prpm upgrade [package]`
+## Stats
 
-Upgrade packages to latest versions (including major updates).
+- **7,500+ packages** - Cursor rules, Claude skills/agents, Windsurf rules, MCP configs
+- **Universal package manager** - Works with Cursor, Claude, Continue, Windsurf and more
+- **100+ Collections** - Complete workflow setups in one command
+- **6+ editor formats** supported (server-side conversion)
 
-```bash
-# Upgrade all packages
-prpm upgrade
-
-# Upgrade specific package
-prpm upgrade react-rules
-
-# Skip warning for major updates
-prpm upgrade --force
-```
-
-**Options:**
-- `--all` - Upgrade all packages
-- `--force` - Skip warning for major version upgrades
-
-**Examples:**
-```bash
-# Upgrade all (including major versions)
-prpm upgrade
-
-# Upgrade specific package
-prpm upgrade react-rules
-
-# Force upgrade without warnings
-prpm upgrade --force
-```
 
----
-
-### Dependencies
-
-#### `prpm deps <package>`
-
-Show dependency tree for a package.
-
-```bash
-# View dependencies
-prpm deps react-rules
-
-# View dependencies for specific version
-prpm deps react-rules@1.2.0
-```
-
-Shows:
-- Resolved dependency versions
-- Dependency tree structure
-- Total dependency count
-
-**Example output:**
-```
-Resolving dependencies for react-rules@1.2.0...
-
-Resolved Dependencies:
-   eslint-config@2.0.0
-   typescript-rules@1.1.0
-
-Total: 2 dependencies
-
-Dependency Tree:
-└─ react-rules@1.2.0
-   ├─ eslint-config@2.0.0
-   └─ typescript-rules@1.1.0
-```
-
----
-
-### Authentication & Publishing
-
-#### `prpm login`
-
-Login to the PRPM registry.
-
-```bash
-# OAuth login (opens browser)
-prpm login
-
-# Login with token
-prpm login --token YOUR_TOKEN
-```
-
-**Options:**
-- `--token <token>` - Login with a personal access token
-
-**Login Flow:**
-1. Opens browser for GitHub authentication
-2. Authorize the application
-3. Token is automatically saved
-4. Ready to publish packages
-
-**Examples:**
-```bash
-# Interactive OAuth login
-prpm login
-
-# Manual token login
-prpm login --token ghp_xxxxxxxxxxxx
-```
-
----
-
-#### `prpm whoami`
-
-Show current logged-in user.
-
-```bash
-prpm whoami
-```
-
-**Example output:**
-```
-username
-```
-
-If not logged in:
-```
-Not logged in
-
-Run "prpm login" to authenticate
-```
-
----
-
-#### `prpm publish`
-
-Publish a package to the registry.
-
-```bash
-# Publish package
-prpm publish
-
-# Dry run (validate without publishing)
-prpm publish --dry-run
-
-# Publish with tag
-prpm publish --tag beta
-```
-
-**Options:**
-- `--access <type>` - Package access (public or private), default: public
-- `--tag <tag>` - NPM-style tag (e.g., latest, beta), default: latest
-- `--dry-run` - Validate package without publishing
-
-**Requirements:**
-- Must be logged in (`prpm login`)
-- Must have `prpm.json` manifest in current directory
-- Package files must exist
-
-**prpm.json format:**
-```json
-{
-  "name": "my-package",
-  "version": "1.0.0",
-  "description": "My awesome package",
-  "type": "cursor",
-  "tags": ["react", "javascript"],
-  "files": [
-    "prpm.json",
-    ".cursorrules",
-    "README.md"
-  ]
-}
-```
-
-**Examples:**
-```bash
-# Publish to registry
-prpm publish
-
-# Test before publishing
-prpm publish --dry-run
-
-# Publish beta version
-prpm publish --tag beta
-```
-
----
-
-### Telemetry
-
-#### `prpm telemetry enable`
-
-Enable anonymous usage analytics.
-
-```bash
-prpm telemetry enable
-```
-
-Helps improve PRPM by collecting anonymous usage data via PostHog.
-
----
+## Contributing
 
-#### `prpm telemetry disable`
+We welcome contributions!
 
-Disable telemetry and analytics.
+-  **Add packages** - Submit your prompts (they'll work in all editors!)
+-  **Create collections** - Curate helpful package bundles
+-  **Report bugs** - Open issues
+-  **Suggest features** - Start discussions
+-  **Write tests** - Improve coverage
 
-```bash
-prpm telemetry disable
-```
+**[Contributing Guide →](CONTRIBUTING.md)**
 
 ---
 
-## Configuration
-
-PRPM stores configuration in `~/.prpmrc`:
-
-```json
-{
-  "registryUrl": "https://registry.prpm.dev",
-  "token": "your-auth-token",
-  "username": "your-username",
-  "defaultFormat": "cursor",
-  "telemetryEnabled": true
-}
-```
-
-### Configuration Options
-
-- `registryUrl` - Registry server URL
-- `token` - Authentication token (set via `prpm login`)
-- `username` - Logged-in username
-- `defaultFormat` - Default package format (cursor, claude, continue, windsurf)
-- `telemetryEnabled` - Enable/disable usage analytics
-
-### Environment Variables
-
-- `PRPM_REGISTRY_URL` - Override registry URL
-- `PRPM_NO_TELEMETRY` - Disable telemetry (set to "1" or "true")
-
-## Project Structure
-
-After installing packages, your project will look like:
-
-```
-my-project/
-├── .cursor/rules/          # Cursor rules
-│   └── react-rules.md
-├── .claude/agents/         # Claude agents
-│   └── typescript-best.md
-├── .continue/              # Continue configs
-├── .windsurf/              # Windsurf configs
-├── .promptpm.json          # Package registry
-└── prpm-lock.json          # Lock file
-```
-
-### Package Registry (`.promptpm.json`)
-
-Tracks installed packages:
-
-```json
-{
-  "packages": [
-    {
-      "id": "react-rules",
-      "type": "cursor",
-      "url": "https://registry.prpm.dev/packages/react-rules",
-      "dest": ".cursor/rules/react-rules.md",
-      "version": "2.1.0"
-    }
-  ]
-}
-```
-
-### Lock File (`prpm-lock.json`)
-
-Ensures consistent installations:
-
-```json
-{
-  "version": "1.0.0",
-  "packages": {
-    "react-rules": {
-      "version": "2.1.0",
-      "tarballUrl": "https://registry.prpm.dev/...",
-      "integrity": "sha512-...",
-      "type": "cursor",
-      "format": "cursor"
-    }
-  }
-}
-```
-
-## Common Workflows
-
-### Starting a New Project
-
-```bash
-# Initialize with popular packages
-prpm install @prpm/starter-kit
-
-# Or install individually
-prpm search react
-prpm install react-rules
-prpm install typescript-rules
-```
-
-### Keeping Packages Updated
-
-```bash
-# Check for updates
-prpm outdated
-
-# Update safe changes (minor/patch)
-prpm update
-
-# Upgrade to latest (including major)
-prpm upgrade
-```
-
-### Working with Collections
-
-```bash
-# Browse collections
-prpm collections
-
-# View collection details
-prpm collections info @prpm/react-starter
-
-# Install collection
-prpm install @prpm/react-starter
-```
-
-### Publishing Your Own Package
-
-```bash
-# 1. Create prpm.json
-cat > prpm.json << EOF
-{
-  "name": "my-rules",
-  "version": "1.0.0",
-  "description": "My custom rules",
-  "type": "cursor",
-  "files": ["prpm.json", ".cursorrules", "README.md"]
-}
-EOF
-
-# 2. Login to registry
-prpm login
-
-# 3. Test package
-prpm publish --dry-run
-
-# 4. Publish
-prpm publish
-```
-
-### Adding Existing Files
-
-```bash
-# If you already have prompt files
-prpm index
-
-# Or add specific files
-prpm add ./my-rules.md --as cursor
-```
-
-### CI/CD Integration
-
-```bash
-# In CI pipeline - use frozen lockfile
-prpm install --frozen-lockfile
-
-# Or install all from lock file
-prpm install
-```
-
-## Supported Formats
-
-PRPM supports multiple AI coding assistant formats:
-
-| Format | Directory | Description |
-|--------|-----------|-------------|
-| `cursor` | `.cursor/rules/` | Cursor IDE rules |
-| `claude` | `.claude/agents/` | Claude sub-agents |
-| `continue` | `.continue/` | Continue extension configs |
-| `windsurf` | `.windsurf/` | Windsurf IDE configs |
-| `canonical` | N/A | Original format (no conversion) |
-
-### Format Conversion
-
-PRPM automatically converts packages between formats:
-
-```bash
-# Install Cursor package as Claude format
-prpm install cursor-rules --as claude
-
-# Install Claude package as Cursor format
-prpm install claude-agent --as cursor
-```
-
-## Troubleshooting
-
-### Command Not Found
-
-```bash
-# Reinstall globally
-npm install -g prpm
-
-# Or check PATH
-echo $PATH
-```
-
-### Authentication Issues
-
-```bash
-# Re-login
-prpm login
-
-# Check current user
-prpm whoami
-
-# Use token directly
-prpm login --token YOUR_TOKEN
-```
-
-### Installation Failures
-
-```bash
-# Check package exists
-prpm search package-name
-
-# Get package info
-prpm info package-name
-
-# Try specific version
-prpm install package-name@1.0.0
-```
-
-### Lock File Issues
-
-```bash
-# Update lock file
-prpm install
-
-# In CI, ensure lock file exists
-prpm install --frozen-lockfile
-```
-
-### Registry Connection Issues
-
-```bash
-# Check registry URL
-cat ~/.prpmrc
-
-# Set custom registry
-export PRPM_REGISTRY_URL=https://custom-registry.com
-```
-
-## Support & Resources
-
-- **GitHub**: https://github.com/pr-pm/prpm
-- **Issues**: https://github.com/pr-pm/prpm/issues
-- **Registry**: https://registry.prpm.dev
-- **Documentation**: https://github.com/pr-pm/prpm#readme
-
-## Contributing
-
-We welcome contributions! See the main repository for contribution guidelines.
-
 ## License
 
-MIT License - see LICENSE file for details.
-
-## Version
-
-Current version: 1.2.0
-
-Requires Node.js >= 16.0.0
+MIT License - See [LICENSE](LICENSE)