Skip to content

CLI Overview ​

The PKP CLI provides commands for creating, validating, building, and generating product catalogs.

Installation ​

bash
npm install -g pkp

Commands ​

CommandDescription
pkp initInitialize a new catalog
pkp validateValidate PRODUCT.md files
pkp buildBuild catalog for deployment
pkp serveServe catalog locally
pkp generateGenerate products with AI

Global Options ​

bash
pkp --version    # Show version
pkp --help       # Show help

Quick Reference ​

bash
# Create new catalog
pkp init my-catalog

# Validate products
pkp validate ./products

# Build for deployment
pkp build . --output ./dist

# Serve locally
pkp serve ./dist --port 3000

# Generate with AI (requires ANTHROPIC_API_KEY)
pkp generate -u https://example.com/product -c notebooks

Environment Variables ​

VariableDescription
ANTHROPIC_API_KEYAPI key for AI generation

Exit Codes ​

CodeMeaning
0Success
1Error (validation failed, build error, etc)

Released under the MIT License.