CLI Help Examples

# Step 1: Discover available registries
pair install --list-targets
 
# Output:
# Available asset registries:
#   github     .github         GitHub workflows and configuration files
#   knowledge  .pair            Knowledge base and documentation
#   adoption   .pair/product/adopted  Adoption guides and onboarding materials
 
# Step 2: Install with defaults
pair install

pair install ./custom-docs

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

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

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

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

pair update

pair update knowledge:.pair

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

pair kb validate

pair kb validate --strict

pair kb validate --layout source

pair kb validate --skip-registries github,adoption

pair kb validate --ignore-config

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

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

pair update-link

pair update-link --dry-run

pair update-link --verbose

pair package

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

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

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

pair package --skip-registries adoption,github

pair package --interactive

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

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

pair 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 kb-verify dist/kb-v1.2.0.zip --json

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

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

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