Common Workflows

Documentation Index

Fetch the complete documentation index at: https://docs.prpm.dev/llms.txt

Use this file to discover all available pages before exploring further.

​

Getting Started with PRPM

​

First Time Setup

1. Install the CLI:
   npm install -g prpm
   
2. Verify installation:
   prpm --version
   
3. Create an account and login:
   prpm login
   
4. Browse available packages:
   prpm trending
   

​

Discovering and Installing Packages

​

Finding the Right Package

prpm search typescript

prpm trending --format cursor

prpm info @username/typescript-rules

# List all collections
prpm collections --list

# View a specific collection
prpm collections web-development

​

Installing Packages

prpm install @username/typescript-best-practices

prpm install \
  @username/react-rules \
  @username/typescript-config \
  @username/testing-guidelines

prpm collections web-development --install

prpm install @username/typescript-rules --as cursor

​

Verifying Installation

prpm list

prpm list --format cursor

prpm list --verbose

​

Managing Existing Projects

​

Indexing Local Prompt Files

# Scan and register all prompt files
prpm index

# View registered packages
prpm list

• .cursor/rules/, .cursor/agents/, .cursor/commands/
• .claude/agents/, .claude/skills/, .claude/commands/
• .continue/rules/
• .windsurf/rules/
• .prompts/
• .mcp/

​

Keeping Packages Up to Date

prpm outdated

prpm update package-name

prpm upgrade

prpm upgrade --dry-run

prpm upgrade --interactive

​

Cleaning Up Packages

prpm uninstall package-name

prpm uninstall package1 package2 package3

prpm uninstall package-name --force

​

Creating and Publishing Packages

​

Creating Your First Package

1. Initialize a new package:
   mkdir @username/my-cursor-rules
   cd @username/my-cursor-rules
   prpm init
   
2. Follow the interactive prompts:
   • Package name: my-username/@username/my-cursor-rules
   • Description: Describe what your package does
   • Format: cursor
   • Subtype: rule
   • Author: Your name
   • License: MIT (or your choice)
   • Tags: typescript, react, best-practices
3. Edit the generated files:
   # Edit your rules file
   vim .cursorrules
   
   # Update the README
   vim README.md
   
4. Test locally:
   # Install in a test project
   cd ../test-project
   prpm install /path/to/@username/my-cursor-rules
   

​

Publishing Your Package

1. Ensure you’re logged in:
   prpm whoami
   # If not logged in:
   prpm login
   
2. Validate your package:
   prpm schema --validate prpm.json
   
3. Test publish (dry run):
   prpm publish --dry-run
   
4. Publish to registry:
   prpm publish
   
5. Verify publication:
   prpm info my-username/@username/my-cursor-rules
   

​

Updating Your Published Package

1. Update version in prpm.json:
   {
     "name": "@username/my-cursor-rules",
     "version": "1.1.0",
     ...
   }
   
2. Publish the update:
   prpm publish
   
3. Publish a beta version:
   # Update version to 2.0.0-beta.1
   prpm publish --tag beta
   

​

Working Across Multiple Projects

​

Setting Up a Standardized Environment

#!/bin/bash
# setup-prpm.sh

echo "Installing standard PRPM packages..."

prpm install \
  @username/typescript-rules \
  @username/react-best-practices \
  @username/testing-guidelines \
  @username/git-commit-standards

echo "Setup complete!"

chmod +x setup-prpm.sh
./setup-prpm.sh

​

Sharing Configurations Across Teams

1. Create a collection for your team:
   • Contact PRPM support or create via registry API
   • Add your team’s standard packages
2. Team members can install everything at once:
   prpm collections your-team-name --install
   

​

Cross-Project Packages

# Create a shared setup script
cat > ~/prpm-setup.sh << 'EOF'
#!/bin/bash
prpm install @username/typescript-rules
prpm install @username/react-patterns
EOF

# Run in each project
chmod +x ~/prpm-setup.sh
cd /path/to/project && ~/prpm-setup.sh

​

Advanced Workflows

​

Using PRPM in CI/CD

# .github/workflows/ci.yml
steps:
  - name: Install PRPM packages
    run: |
      npm install -g prpm
      prpm install @username/typescript-rules1 @username/typescript-rules2
    env:
      PRPM_TOKEN: ${{ secrets.PRPM_TOKEN }}

steps:
  - name: Check for outdated packages
    run: |
      prpm outdated --json > outdated.json
      if [ $(jq length outdated.json) -gt 0 ]; then
        echo "Outdated packages found!"
        exit 1
      fi

​

Scripting with PRPM

#!/bin/bash
if prpm list --json | jq -e '.[] | select(.id=="package-name")' > /dev/null; then
  echo "Package is installed"
else
  echo "Package not found"
  prpm install @username/typescript-rules
fi

#!/bin/bash
# Update all cursor packages
prpm list --format cursor --json | \
  jq -r '.[].id' | \
  xargs prpm update

​

Custom Registry

# Set custom registry
prpm config set registry https://registry.example.com

# Or use environment variable
export PRPM_REGISTRY_URL=https://registry.example.com
prpm search internal-packages

# Production registry
alias prpm-prod='PRPM_REGISTRY_URL=https://registry.prpm.dev prpm'

# Development registry
alias prpm-dev='PRPM_REGISTRY_URL=https://dev.registry.prpm.dev prpm'

# Use them
prpm-prod search typescript
prpm-dev publish

​

Troubleshooting Common Issues

​

Package Not Found

# Ensure you're using the correct package name
prpm search package-name

# Check if you're authenticated (for private packages)
prpm whoami

# Try specifying a version
prpm install @username/typescript-rules --version 1.0.0

​

Installation Fails

# Check for conflicting files
ls -la .cursor/rules/

# Force reinstall
prpm uninstall package-name
prpm install @username/typescript-rules --force

# Check disk space and permissions
df -h
ls -la .cursor/

​

Authentication Issues

# Re-authenticate
prpm login

# Check current auth status
prpm whoami

# Manually set token
prpm config set token YOUR_TOKEN

​

Updates Not Working

# Check what's outdated
prpm outdated

# Try force update
prpm update package-name --force

# Or uninstall and reinstall
prpm uninstall package-name
prpm install @username/typescript-rules

​

Lock File Conflicts

# Rebuild lock file from installed packages
prpm index

# Or manually edit prpm.lock if needed
vim prpm.lock

​

Best Practices

​

For Package Users

1. Always check package info before installing:
   prpm info @username/typescript-rules
   
2. Keep packages updated:
   # Set up a weekly reminder
   prpm outdated
   
3. Convert to your preferred format:
   prpm install package-name --as cursor  # Convert to Cursor format
   prpm install package-name --as claude  # Convert to Claude format
   
4. Document your dependencies:
   # README.md
   
   ## PRPM Packages
   
   This project uses:
   - `@username/typescript-rules` - TypeScript coding standards
   - `@username/react-patterns` - React best practices
   

​

For Package Authors

1. Follow semantic versioning:
   • Patch: Bug fixes (1.0.1)
   • Minor: New features (1.1.0)
   • Major: Breaking changes (2.0.0)
2. Write comprehensive READMEs:
   • What the package does
   • Installation instructions
   • Usage examples
   • Configuration options
3. Use descriptive tags:
   {
     "tags": ["typescript", "react", "testing", "best-practices"]
   }
   
4. Test before publishing:
   prpm publish --dry-run
   
5. Keep packages focused:
   • One clear purpose per package
   • Split large packages into smaller ones
   • Use collections to group related packages

​

Getting Help

• Command help: prpm <command> --help
• GitHub Issues: https://github.com/pr-pm/prpm/issues