Quick Start

Get started with pnpm-catalog-updates in minutes. This guide will walk you through installation, initialization, and your first dependency update.

pnpm-catalog-updates is specifically designed for pnpm workspaces using catalog dependencies. Make sure you have a pnpm workspace before getting started.

Installation

Choose your preferred installation method:

npm install -g pcu
# or
npm install -g pcu

Initialize Your Workspace

If you don't have a pnpm workspace yet, PCU can create one for you:

pcu init

This command creates:

.pcurc.json - PCU configuration file
package.json - Workspace root package.json (if missing)
pnpm-workspace.yaml - PNPM workspace configuration (if missing)
packages/ - Directory for workspace packages (if missing)

Your First Update Check

Check for outdated catalog dependencies:

pcu -c

This will show you a beautiful table with:

Current versions in your catalogs
Latest available versions
Package names and update types
Color-coded urgency indicators

Interactive Updates

Update dependencies with an interactive interface:

pcu -i

This lets you:

✅ Choose which dependencies to update
🎯 Select specific versions
📊 See impact analysis
🔒 Create backups automatically

Common Commands

Here are the most frequently used commands:

Command	Description	Example
`pcu init`	Initialize workspace	`pcu init --verbose`
`pcu -c`	Check for updates	`pcu -c --catalog default`
`pcu -i`	Interactive updates	`pcu -i -b`
`pcu -u`	Update dependencies	`pcu -u --target minor`
`pcu -a`	Analyze impact	`pcu -a default react`

What's Next?

Resources

Configuration

Learn about PCU configuration options and how to customize your setup for different workflows.

Examples

Explore practical examples and common use cases for managing dependencies with PCU.

Troubleshooting

Common issues and solutions when using PCU. Error messages, debugging tips, and troubleshooting guides.

Development

Learn about development workflows, contributing guidelines, and advanced PCU usage patterns.

Getting Started Checklist

Follow this checklist to get PCU running in your project:

Install PCU - Choose global installation or use npx
Initialize workspace - Run pcu init for first-time setup
Check for updates - Use pcu -c to see available updates
Configure settings - Customize .pcurc.json for your needs
Update dependencies - Use interactive mode pcu -i for safe updates
Set up automation - Consider CI/CD integration for regular checks

Essential Commands Quick Reference

Command	Purpose	When to Use
`pcu init`	Setup workspace	First time setup, new projects
`pcu -c`	Check updates	Daily development, CI checks
`pcu -i`	Interactive update	Safe manual updates
`pcu -u`	Batch update	Automated updates, CI/CD
`pcu security`	Security scan	Before releases, regular audits

Next Steps

Once you have PCU set up, explore these advanced features:

Configuration - Customize PCU for your specific workflow
Security Scanning - Integrate vulnerability scanning
Monorepo Management - Advanced workspace features
CI/CD Integration - Automate dependency updates in your pipeline