CLI Help Examples

# Step 1: Discover available registries
pair-cli install --list-targets

  Asset Registries

  github
    target:   .github
    behavior: mirror
    GitHub workflows and configuration files

  knowledge
    target:   .pair/knowledge
    behavior: mirror
    Knowledge base and documentation

  adoption
    target:   .pair/adoption
    behavior: add
    Adoption guides and onboarding materials

  agents
    target:   AGENTS.md
    behavior: mirror
    AI agents guidance and session context

  skills
    target:   .claude/skills/
    behavior: overwrite
    Agent skills distributed to AI tool directories

  workflows
    target:   .claude/workflows/
    behavior: overwrite
    Batch orchestration workflows (Claude Code only; inert elsewhere)

  agent-definitions
    target:   .claude/agents/
    behavior: overwrite
    Agent execution layer the workflows dispatch to (pair-implementer, pair-reviewer, pair-contract-generator)

# Step 2: Install with defaults
pair-cli install

pair-cli install ./custom-docs

# Install only GitHub workflows
pair-cli install github:.github
 
# Install multiple specific registries
pair-cli install github:.github knowledge:.pair

pair-cli install --source https://internal-mirror.company.com/kb-v1.2.0.zip

# Use absolute path to local KB
pair-cli install --source /home/user/kb-content
 
# Use relative path to local KB
pair-cli install --source ./local-kb

# Offline mode requires --source with local path
pair-cli install --offline --source ./kb-content
 
# Error if --offline without --source
pair-cli install --offline
# Error: --offline requires --source with local filesystem path

pair-cli update

pair-cli update knowledge:.pair

pair-cli update --source https://github.com/org/repo/releases/download/v2.0.0/kb.zip

pair-cli kb-validate

pair-cli kb-validate --strict

pair-cli kb-validate --layout source

pair-cli kb-validate --skip-registries github,adoption

pair-cli kb-validate --ignore-config

pair-cli validate-config
 
# Output:
# Configuration is valid!
# Found 3 asset registries

pair-cli validate-config --config ./custom-config.json

pair-cli update-link

pair-cli update-link --dry-run

pair-cli update-link --verbose

pair-cli package

pair-cli package -o dist/kb-v1.2.0.zip

pair-cli package \
  --name "Company Knowledge Base" \
  --pkg-version "1.2.0" \
  --description "Internal documentation and guides" \
  --author "DevOps Team" \
  -o dist/company-kb-v1.2.0.zip

pair-cli package -s ./kb-content -o kb.zip --log-level debug

pair-cli package --skip-registries adoption,github

pair-cli package --interactive

pair-cli package --org --org-name "Acme Corp" --team "Platform" --department "Engineering" \
  --compliance "SOC2,ISO27001" --distribution private \
  -o dist/acme-kb.zip

pair-cli kb-info dist/kb-v1.0.0.zip

pair-cli kb-verify kb-package.zip
 
# Output:
# Package verification passed
#   Checksum: valid (SHA-256)
#   Structure: valid (3 registries found)
#   Manifest: valid (all required fields present)

pair-cli kb-verify dist/kb-v1.2.0.zip --json

# Complete workflow: verify then install
pair-cli kb-verify downloaded-kb.zip && pair-cli install --source downloaded-kb.zip

#!/bin/bash
# CI/CD script for KB installation and validation
 
# Step 1: Validate configuration
pair-cli validate-config || exit 1
 
# Step 2: Install KB from specific release
pair-cli install --source https://github.com/org/repo/releases/download/v1.2.0/kb.zip || exit 1
 
# Step 3: Validate and fix links
pair-cli update-link || exit 1
 
# Step 4: Package for distribution
pair-cli package --name "Production KB" --pkg-version "1.2.0" -o dist/kb-production-v1.2.0.zip || exit 1
 
# Step 5: Verify package integrity
pair-cli kb-verify dist/kb-production-v1.2.0.zip || exit 1

# Step 1: On internet-connected machine
wget https://github.com/org/repo/releases/download/v1.2.0/kb.zip
 
# Step 2: Transfer kb.zip to air-gapped machine (USB, etc.)
 
# Step 3: On air-gapped machine
unzip kb.zip -d ./kb-content
pair-cli install --offline --source ./kb-content

# Development environment (use latest from main)
pair-cli install --source https://github.com/org/repo/archive/main.zip
 
# Staging environment (use release candidate)
pair-cli install --source https://github.com/org/repo/releases/download/v1.3.0-rc.1/kb.zip
 
# Production environment (use stable release)
pair-cli install --source https://github.com/org/repo/releases/download/v1.2.0/kb.zip

pnpm --filter pair-cli dev update .

#!/bin/bash
# setup.sh
pnpm install
pnpm dlx pair-cli install
pnpm dlx pair-cli update-link --dry-run

# .github/workflows/ci.yml
- name: Install pair assets
  run: |
    npm install -g @foomakers/pair-cli
    pair-cli install

pair-cli update
pair-cli update-link --dry-run
pair-cli update-link
git add .pair/
git commit -m "chore: update KB content and fix links"

mkdir /tmp/pair-test && cd /tmp/pair-test
pair-cli install
cd - && rm -rf /tmp/pair-test