# CLI Commands Reference The PACT QR CLI provides a comprehensive command-line interface for QR code generation, verification, and enterprise management. This reference covers all 25+ available commands with detailed examples and options. ## Installation ```bash # Install globally npm install -g @pact/qr-verify-cli # Or use without installation npx @pact/qr-verify-cli # Verify installation pact-qr --version ``` ## Global Options Available with all commands: ```bash -v, --verbose Enable verbose output --api-url API base URL (default: http://localhost:3001) -h, --help Display help for command ``` ## Authentication Commands ### auth Parent command for authentication operations. ```bash pact-qr auth ``` #### auth login Interactive Web3 wallet authentication. ```bash pact-qr auth login [options] Options: --wallet

Wallet address to authenticate --skip-browser Skip opening browser for MetaMask connection ``` **Example:** ```bash # Interactive login pact-qr auth login # Login with specific wallet pact-qr auth login --wallet 0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6 ``` #### auth enterprise-login Enterprise authentication with API keys and license validation. ```bash pact-qr auth enterprise-login [options] Options: --email Enterprise email address --license Enterprise license number --org Organization name --tier Subscription tier (government|enterprise|enterprise-plus) ``` **Example:** ```bash # Government customer login pact-qr auth enterprise-login \ --email admin@defense.gov \ --license GOVT-2024-001 \ --org "Department of Defense" \ --tier government # Enterprise customer login pact-qr auth enterprise-login \ --email cto@company.com \ --license ENT-2024-042 \ --tier enterprise ``` #### auth status Check current authentication status and session information. ```bash pact-qr auth status ``` **Example Output:** ``` ✓ Authenticated Email: admin@company.gov Organization: Department of Defense Tier: government License: GOVT-2024-001 API Key: pk_live_***...4f2e (active) Session expires: 2024-01-02T00:00:00.000Z ``` ## Project Management Commands ### init Initialize a new QR verification project. ```bash pact-qr init [project-name] [options] Options: --use-case Use case identifier --wallet

Default authorized wallet --type Default QR type (static|dynamic) --skip-prompts Skip interactive prompts ``` **Example:** ```bash # Interactive initialization pact-qr init my-project # Non-interactive initialization pact-qr init conference-2024 \ --use-case "event-checkin" \ --wallet 0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6 \ --type dynamic \ --skip-prompts ``` ## QR Code Generation Commands ### generate Generate a single QR code. ```bash pact-qr generate [options] Options: --type QR type: static|dynamic (default: static) --wallets Authorized wallet addresses (comma-separated) --expires Expiration date (ISO format or relative) --time-window Daily time window (HH:MM-HH:MM) --timezone Timezone (default: UTC) --days Valid days of week (0-6, comma-separated) --output Output file for QR data --image Generate QR code image --format Image format: png|svg (default: png) ``` **Examples:** ```bash # Basic static QR code pact-qr generate event-checkin # Dynamic QR with expiration pact-qr generate conference-2024 \ --type dynamic \ --expires "2024-12-31T23:59:59Z" \ --wallets 0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6 # QR with time restrictions pact-qr generate office-access \ --time-window "09:00-17:00" \ --timezone "America/New_York" \ --days "1,2,3,4,5" # Generate with image output pact-qr generate badge-scan \ --image \ --format svg \ --output ./qr-codes/badge.svg ``` ### batch Generate multiple QR codes in batch. ```bash pact-qr batch [options] Options: --type QR type: static|dynamic (default: static) --wallets Authorized wallet addresses (comma-separated) --expires Expiration date for all QR codes --time-window Daily time window (HH:MM-HH:MM) --timezone Timezone (default: UTC) --days Valid days of week (0-6, comma-separated) --prefix QR ID prefix --output Output directory for batch files --images Generate images for all QR codes --format Image format: png|svg (default: png) ``` **Examples:** ```bash # Generate 100 conference badges pact-qr batch conference-2024 100 \ --wallets 0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6,0x123... \ --expires "2024-06-30T23:59:59Z" \ --prefix "CONF24-" # Generate employee access cards with time restrictions pact-qr batch employee-access 50 \ --time-window "08:00-18:00" \ --timezone "America/Los_Angeles" \ --days "1,2,3,4,5" \ --images \ --output ./employee-badges/ ``` ## QR Code Management Commands ### list List QR codes with filtering options. ```bash pact-qr list [options] Options: --use-case Filter by use case --status Filter by status (active|expired|used) --wallet

Filter by authorized wallet --limit Limit number of results (default: 50) --offset Offset for pagination --format Output format: table|json|csv (default: table) ``` **Examples:** ```bash # List all QR codes pact-qr list # List active QR codes for specific use case pact-qr list --use-case conference-2024 --status active # Export to CSV pact-qr list --format csv > qr-codes.csv # List with pagination pact-qr list --limit 25 --offset 50 ``` ### verify Verify a QR code. ```bash pact-qr verify [options] Options: --wallet

Wallet address for verification --signature Wallet signature for verification --location GPS coordinates (lat,lng) --timestamp Custom timestamp (ISO format) --dry-run Perform verification without recording ``` **Examples:** ```bash # Basic verification pact-qr verify "qr-data-string" \ --wallet 0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6 \ --signature 0x8f4f6c4c... # Verification with location pact-qr verify "qr-data-string" \ --wallet 0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6 \ --signature 0x8f4f6c4c... \ --location "37.7749,-122.4194" # Dry run verification pact-qr verify "qr-data-string" --dry-run ``` ## Smart Contract Commands ### generate-contract Generate smart contract for use case. ```bash pact-qr generate-contract [options] Options: --name Contract name --symbol Token symbol --reward Reward amount per verification --output Output file for contract code ``` **Examples:** ```bash # Generate conference contract pact-qr generate-contract conference-2024 \ --name "Conference2024Token" \ --symbol "CONF24" \ --reward 10 # Generate and save to file pact-qr generate-contract event-rewards \ --output ./contracts/EventRewards.sol ``` ### deploy-contract Deploy smart contract to blockchain. ```bash pact-qr deploy-contract [options] Options: --network Target network (sepolia|polygon|mainnet) --gas-limit Gas limit for deployment --gas-price Gas price in gwei --verify Verify contract on block explorer ``` **Examples:** ```bash # Deploy to Sepolia testnet pact-qr deploy-contract ./contracts/EventRewards.sol \ --network sepolia \ --verify # Deploy with custom gas settings pact-qr deploy-contract ./contracts/Conference.sol \ --network polygon \ --gas-limit 500000 \ --gas-price 30 ``` ## Billing Commands (Enterprise) ### billing Parent command for billing operations (enterprise customers only). ```bash pact-qr billing ``` #### billing status Check current billing status and subscription information. ```bash pact-qr billing status ``` **Example Output:** ``` ✓ Enterprise Subscription Active Tier: Government Plan: $15,000/month Billing Period: January 1 - January 31, 2024 Usage this month: QR Codes: 15,420 / 100,000 (15.4%) Smart Contracts: 12 / 50 (24%) API Calls: 1,245,678 Next billing date: February 1, 2024 ``` #### billing usage View detailed usage statistics. ```bash pact-qr billing usage [options] Options: --months Number of months to show (default: 3) --format Output format: table|json|csv (default: table) --detailed Show detailed breakdown ``` **Example:** ```bash # View last 6 months pact-qr billing usage --months 6 --detailed # Export usage data pact-qr billing usage --format csv > usage-report.csv ``` ## Image Export Commands ### export-images Export QR code as image files. ```bash pact-qr export-images [output-path] [options] Options: --format Image format: png|svg (default: png) --size Image size in pixels (default: 256) --margin Margin size (default: 4) --color Foreground color (default: #000000) --background Background color (default: #ffffff) ``` **Examples:** ```bash # Export as PNG pact-qr export-images qr-123 ./images/qr-123.png # Export as SVG with custom colors pact-qr export-images qr-123 ./images/qr-123.svg \ --format svg \ --color "#003366" \ --background "#f0f8ff" # Export large size PNG pact-qr export-images qr-123 ./images/qr-123-large.png \ --size 512 \ --margin 8 ``` ### batch-export Export all QR code images for a use case. ```bash pact-qr batch-export [directory] [options] Options: --format Image format: png|svg (default: png) --size Image size in pixels (default: 256) --naming File naming pattern (default: {{id}}.{{ext}}) ``` **Examples:** ```bash # Export all conference QR codes pact-qr batch-export conference-2024 ./conference-badges/ # Export with custom naming pact-qr batch-export employee-access ./badges/ \ --naming "badge-{{id}}-{{timestamp}}.{{ext}}" ``` ## Data Export Commands ### export Export QR code data and analytics. ```bash pact-qr export [options] Options: --use-case Filter by use case --format Export format: json|csv|xml (default: json) --output Output file --include Data types to include (qr,scans,analytics) --date-range Date range (start,end) ``` **Examples:** ```bash # Export all data as JSON pact-qr export json --output full-export.json # Export specific use case as CSV pact-qr export csv \ --use-case conference-2024 \ --output conference-data.csv # Export with date range pact-qr export json \ --date-range "2024-01-01,2024-01-31" \ --include qr,scans \ --output january-report.json ``` ## Configuration Commands ### config Manage CLI configuration settings. ```bash pact-qr config ``` #### config set Set configuration values. ```bash pact-qr config set Examples: pact-qr config set api-url https://api.qr-verify.com pact-qr config set default-wallet 0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6 pact-qr config set output-format table ``` #### config get Get configuration values. ```bash pact-qr config get Examples: pact-qr config get api-url pact-qr config get default-wallet ``` #### config list List all configuration values. ```bash pact-qr config list ``` ## Network Commands ### network Manage blockchain network connections. ```bash pact-qr network ``` #### network list List available networks. ```bash pact-qr network list ``` #### network set Set active network. ```bash pact-qr network set Examples: pact-qr network set sepolia pact-qr network set polygon-amoy pact-qr network set mainnet ``` #### network status Check network connection status. ```bash pact-qr network status ``` ## Global Configuration ### Environment Variables The CLI respects these environment variables: ```bash # API Configuration PACT_QR_API_URL=https://api.qr-verify.com PACT_QR_API_KEY=pk_live_... # Authentication PACT_QR_ENTERPRISE_EMAIL=admin@company.com PACT_QR_LICENSE_KEY=ENT-2024-001 # Network Configuration PACT_QR_NETWORK=sepolia PACT_QR_RPC_URL=https://sepolia.infura.io/v3/... # Output Configuration PACT_QR_OUTPUT_FORMAT=table PACT_QR_VERBOSE=true ``` ### Configuration File CLI configuration is stored in `~/.pact-qr/config.json`: ```json { "apiUrl": "https://api.qr-verify.com", "defaultWallet": "0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6", "defaultTier": "enterprise", "outputFormat": "table", "timeout": 30000, "auth": { "email": "admin@company.com", "customerId": "customer_123", "apiKey": "pk_live_...", "sessionToken": "sess_..." } } ``` ## Error Handling ### Common Exit Codes - `0`: Success - `1`: General error - `2`: Authentication error - `3`: Network error - `4`: Invalid arguments - `5`: Permission denied - `6`: Resource not found - `7`: Rate limit exceeded ### Error Output Format ```json { "success": false, "error": { "code": "AUTHENTICATION_REQUIRED", "message": "Please login first using 'pact-qr auth login'", "details": { "command": "generate", "requiredAuth": true } } } ``` ## Tips and Best Practices ### 1. Use Configuration Files ```bash # Set default values pact-qr config set api-url https://api.qr-verify.com pact-qr config set default-wallet 0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6 ``` ### 2. Batch Operations ```bash # Use batch commands for efficiency pact-qr batch conference-2024 1000 --images # Instead of 1000 individual generate commands ``` ### 3. Output Formats ```bash # Use JSON for scripting pact-qr list --format json | jq '.data[] | select(.status == "active")' # Use CSV for spreadsheets pact-qr billing usage --format csv > monthly-report.csv ``` ### 4. Error Handling in Scripts ```bash #!/bin/bash if pact-qr auth status > /dev/null 2>&1; then echo "Authenticated" pact-qr generate conference-2024 else echo "Please login first" exit 1 fi ``` --- For more information, see: - [CLI Installation Guide](./installation.md) - [Authentication Guide](./authentication.md) - [Configuration Guide](./configuration.md) - [API Reference](../api/) - [Troubleshooting Guide](./troubleshooting.md)