@pattern5/cli

CLI for Pattern5 — query and manage your team's coding standards from the terminal.

Install

npm install -g @pattern5/cli

Quick start

# 1. Authenticate via browser
pattern5 login

# 2. Search your standards
pattern5 search "error handling"

# 3. View full details
pattern5 get <artifact-id>

Commands

| Command | Description | |---------|-------------| | pattern5 login | Authenticate with Pattern5 via browser-based OAuth | | pattern5 logout | Clear stored credentials | | pattern5 whoami | Show current authentication status | | pattern5 search <query> | Search artifacts by keyword | | pattern5 list | List published artifacts | | pattern5 get <id> | Get full artifact details by ID | | pattern5 collections | List available collections | | pattern5 collections add <collection> <ids...> | Add artifacts to a collection | | pattern5 collections remove <collection> <id> | Remove an artifact from a collection | | pattern5 submit | Create a new artifact | | pattern5 update <id> | Update an existing artifact | | pattern5 manage <id> | Unpublish or dismiss an artifact | | pattern5 config | Manage CLI configuration |

Authentication

OAuth (recommended) — opens a browser to sign in:

pattern5 login

API key — for CI/CD or headless environments:

pattern5 config set-key <your-api-key>

Generate API keys at app.pattern5.dev/settings/api-keys.

Configuration

pattern5 config              # Show current config
pattern5 config set-url <url>         # Set API URL
pattern5 config set-collection <id>   # Set default collection
pattern5 config reset                 # Reset to defaults

Config is stored in ~/.config/pattern5/.

Examples

# Search with JSON output
pattern5 search "authentication" --json

# List only standards
pattern5 list --type standard

# Submit an artifact from a file
pattern5 submit --file pattern.yaml

# Submit and assign to a collection
pattern5 submit --type standard --title "..." --description "..." \
  --collection "My Collection" --file sections.json

# Pipe content via stdin
cat pattern.yaml | pattern5 submit --stdin

# Add existing artifacts to a collection
pattern5 collections add "My Collection" d50e719d a82daf9d

# Remove an artifact from a collection
pattern5 collections remove "My Collection" d50e719d

# Use a specific collection for queries
pattern5 search "caching" --collection <collection-id>

Global options

| Option | Description | |--------|-------------| | --json | Output as JSON | | --api-url <url> | Override API URL | | --api-key <key> | Override API key | | --help | Show help | | --version | Show version |

Requirements

• Node.js 22 or later

Links

• Pattern5

License

MIT