# PACT OS CLI - API Reference This document provides comprehensive API reference for PACT OS CLI commands, including detailed parameter specifications, response formats, and integration examples for the meta-agent orchestration system. ## Table of Contents - [Command Interface](#command-interface) - [Global Options](#global-options) - [Commands](#commands) - [verify](#verify) - [issue-license](#issue-license) - [ai](#ai) - [workflow](#workflow) - [orchestrate](#orchestrate) - [status](#status) - [logs](#logs) - [proofs](#proofs) - [Tool Forwarding](#tool-forwarding) - [Data Models](#data-models) - [Response Formats](#response-formats) - [Error Handling](#error-handling) - [Integration Examples](#integration-examples) ## Command Interface All PACT OS CLI commands follow a consistent interface pattern: ```bash pact-os [options] [--global-options] pact-os [tool-args...] [--global-options] ``` ### Exit Codes - `0`: Success - `1`: General error - `2`: Configuration error - `3`: Tool not found - `4`: Workflow error - `5`: AI service error - `6`: Orchestration error ## Global Options These options are available for all commands: | Option | Type | Description | Default | |--------|------|-------------|---------| | `--config ` | string | Path to configuration file | `~/.pactrc` | | `--verbose` | boolean | Enable verbose output | false | | `--no-banner` | boolean | Disable startup banner | false | | `--json` | boolean | Output results in JSON format | false | | `--proof` | boolean | Generate cryptographic proof | false | | `--debug` | boolean | Enable debug mode | false | | `--help` | boolean | Show command help | false | | `--version` | boolean | Show version information | false | ## Commands ### verify Comprehensive verification of wallet or entity using multiple PACT tools. #### Syntax ```bash pact-os verify [options] ``` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `identifier` | string | Yes | Wallet address or entity ID | #### Options | Option | Type | Description | Default | |--------|------|-------------|---------| | `--deep` | boolean | Perform deep analysis including timeline | false | | `--export ` | string | Export results to file | - | #### Response Format **Standard Output:** ``` 📊 Verification Summary ────────────────────────────────────────────────── Identifier: 0xABC123...def Status: ✓ PASSED Risk Score: 0.25 Compliance Score: 0.85 📋 Verification Steps: ✓ Risk prediction analysis (ppre) ✓ Compliance score calculation (pact-entity) ✓ DeFi activity analysis (pact-defi) ✓ QR verification history (qr-verify) ``` **JSON Output (`--json`):** ```json { "identifier": "0xABC123...def", "timestamp": "2024-08-01T12:00:00Z", "steps": [ { "tool": "ppre", "description": "Risk prediction analysis", "success": true, "output": "Risk Score: 0.25 (Low)\nNo sanctions matches found..." }, { "tool": "pact-entity", "description": "Compliance score calculation", "success": true, "output": "Compliance Score: 0.85\nKYC Status: Verified..." } ], "overallStatus": "PASSED", "riskScore": 0.25, "complianceScore": 0.85, "proof": "pact-proof-a1b2c3d4e5f6g7h8" } ``` #### Examples ```bash # Basic verification pact-os verify 0xABC123...def # Deep verification with export pact-os verify alice.eth --deep --export verification-report.json # JSON output with proof pact-os verify entity-123 --json --proof ``` ### issue-license Issue compliance license NFT with automated verification. #### Syntax ```bash pact-os issue-license [options] ``` #### Options | Option | Type | Required | Description | Default | |--------|------|----------|-------------|---------| | `--to

` | string | Yes | Recipient wallet address | - | | `--type ` | string | Yes | License type | - | | `--duration ` | number | No | License validity in days | 365 | | `--metadata ` | string | No | Additional metadata | - | #### License Types | Type | Description | Requirements | |------|-------------|--------------| | `kyc-verified` | KYC verification completed | Entity profile, ID verification | | `aml-compliant` | AML compliance certified | Transaction history, risk assessment | | `defi-approved` | DeFi participation approved | Risk score < 0.3, compliance > 0.7 | | `institutional` | Institutional grade compliance | Enhanced due diligence | #### Response Format **Standard Output:** ``` 🎫 License Issuance ────────────────────────────────────────────────── Recipient: 0x123...abc Type: kyc-verified Duration: 365 days Status: ✓ ISSUED Transaction: 0xdef...789 Token ID: 12345 Expiry: 2025-08-01T12:00:00Z ``` **JSON Output (`--json`):** ```json { "success": true, "license": { "recipient": "0x123...abc", "type": "kyc-verified", "duration": 365, "tokenId": 12345, "transactionHash": "0xdef...789", "expiry": "2025-08-01T12:00:00Z", "metadata": { "issuer": "PACT Protocol", "timestamp": "2024-08-01T12:00:00Z", "verificationLevel": "standard" } }, "proof": "pact-proof-b2c3d4e5f6g7h8i9" } ``` #### Examples ```bash # Issue KYC license pact-os issue-license --to 0x123...abc --type kyc-verified # Issue institutional license with metadata pact-os issue-license --to 0x456...def --type institutional --duration 730 \ --metadata '{"level": "enhanced", "jurisdiction": "US"}' # Issue with JSON output pact-os issue-license --to 0x789...ghi --type defi-approved --json ``` ### ai Natural language AI assistant for complex operations and monitoring. #### Syntax ```bash pact-os ai [prompt] [options] ``` #### Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `prompt` | string | No | Initial prompt (optional) | #### Options | Option | Type | Description | Default | |--------|------|-------------|---------| | `--model ` | string | AI model to use | gpt-4 | | `--interactive` | boolean | Enter interactive mode | true | | `--mode ` | string | Operation mode | chat | | `--interval ` | string | Time interval for monitor | - | | `--entity ` | string | Entity ID to monitor | - | | `--output ` | string | Output file for results | - | | `--quiet` | boolean | Suppress CLI output | false | #### Operation Modes | Mode | Description | Required Options | |------|-------------|------------------| | `chat` | Interactive AI assistant | - | | `monitor` | Continuous compliance monitoring | `--interval` | #### Time Interval Formats | Format | Description | Examples | |--------|-------------|----------| | `Xh` | Hours | 24h, 48h, 72h | | `Xd` | Days | 7d, 14d, 30d | #### Response Format (Chat Mode) **Interactive Session:** ``` 🤖 PACT OS AI Assistant Type your commands in natural language. Type "exit" to quit. You: Check wallet 0xABC for compliance issues