# PACT Gov CLI - Quick Start Guide Get up and running with PACT Gov CLI for government regulatory operations management. This guide covers installation, basic configuration, and essential commands to start managing regulatory compliance. ## Prerequisites - **Node.js 18+** - [Download here](https://nodejs.org/) - **npm or yarn** - Package manager (comes with Node.js) - **Terminal/Command Line** - Access to command line interface - **Government Authority** - Valid government entity credentials Optional: - **Legal Document Management System** - For regulation content storage - **Publication Infrastructure** - For multi-channel regulation publishing ## Installation ### Method 1: NPM Global Install (Recommended) ```bash npm install -g pact-gov ``` ### Method 2: From Source ```bash git clone https://github.com/pact-protocol/pact-gov cd pact-gov npm install npm run build npm link ``` ### Verify Installation ```bash pact-gov --version pact-gov --help ``` Expected output: ``` 1.0.0 Usage: pact-gov [options] [command] PACT Gov CLI - Government regulatory operations ... ``` ## Initial Setup ### 1. Basic Configuration Create a configuration file for your government entity: ```bash mkdir -p ~/.pact cat > ~/.pactrc << EOF { "logLevel": "info", "governmentId": "regulatory-authority", "jurisdiction": "federal" } EOF ``` ### 2. Environment Variables Set up your regulatory authority credentials: ```bash # Add to your ~/.bashrc, ~/.zshrc, or equivalent export PACT_LOG_LEVEL="info" export PACT_GOVERNMENT_ID="regulatory-authority" export PACT_JURISDICTION="federal" export PACT_API_ENDPOINT="https://api.pact.protocol" ``` Apply changes: ```bash source ~/.bashrc # or ~/.zshrc ``` ### 3. Verify Configuration ```bash pact-gov status ``` Expected output: ``` ____ _ ____ _____ ____ _____ __ | _ \ / \ / ___|_ _| / ___|/ _ \ \ / / | |_) / _ \| | | | | | _| | | \ \ / / | __/ ___ \| |___ | | | |_| | |_| |\ V / |_| /_/ \_\____| |_| \____|\___/ \_/ Government regulatory operations management PACT Gov System Status Regulations: Total: 0 Active: 0 Draft: 0 System Health: ✓ Operational ``` ## Your First Regulation ### 1. Create a Financial Regulation ```bash pact-gov regulation new --title "Know Your Customer Requirements" --type financial ``` Expected output: ``` ✓ Regulation created successfully ID: reg-a1b2c3d4e5f6 Title: Know Your Customer Requirements Type: financial Status: draft Version: 1.0.0 Created: 2024-08-01T12:00:00Z ``` ### 2. View Your Regulation ```bash pact-gov regulation view --id reg-a1b2c3d4e5f6 ``` ### 3. List All Regulations ```bash pact-gov regulation list ``` ## Essential Commands ### Update Regulation Content ```bash # Update regulation title pact-gov regulation update --id reg-a1b2c3d4e5f6 --title "Enhanced KYC Requirements" # Update regulation type pact-gov regulation update --id reg-a1b2c3d4e5f6 --type financial ``` ### Publish Your Regulation ```bash # Publish with effective date pact-gov publish --regulation reg-a1b2c3d4e5f6 --effective "2024-09-01" # Publish as draft for review pact-gov publish --regulation reg-a1b2c3d4e5f6 --draft ``` Expected output: ``` ✓ Regulation published successfully Regulation: reg-a1b2c3d4e5f6 Status: published Effective Date: 2024-09-01 Channels: official-gazette, website, api Notifications Sent: 1,247 ``` ### Check System Status ```bash # Basic status pact-gov status # Detailed status pact-gov status --detailed # Specific regulation status pact-gov status --regulation reg-a1b2c3d4e5f6 ``` ## Working with Enforcement ### Issue Compliance Actions ```bash # Issue a warning pact-gov enforce --regulation reg-a1b2c3d4e5f6 --entity company-alpha --action warn # Apply a fine pact-gov enforce --regulation reg-a1b2c3d4e5f6 --entity company-beta --action fine --severity high # Suspend operations pact-gov enforce --regulation reg-a1b2c3d4e5f6 --entity non-compliant-entity --action suspend ``` Expected output for fine: ``` ✓ Enforcement action created Action ID: enf-m3n4o5p6q7r8 Regulation: reg-a1b2c3d4e5f6 Entity: company-beta Action: fine Severity: high Penalty: $50,000 Deadline: 2024-08-31T23:59:59Z ``` ## Conducting Audits ### Run Compliance Audits ```bash # System-wide audit pact-gov audit --regulation all --period 2024Q3 # Specific regulation audit pact-gov audit --regulation reg-a1b2c3d4e5f6 --period 2024Q3 --depth comprehensive # Entity-specific audit pact-gov audit --entity company-alpha --depth basic ``` Expected output: ``` Audit Report for 2024Q3 Summary: Entities Audited: 156 Compliance Rate: 87% Issues Found: 23 Findings by Severity: High Risk [██░░░] 3 issues Medium Risk [████░] 8 issues Low Risk [██████] 12 issues ``` ## Creating Regulatory Frameworks ### Organize Regulations ```bash # Create a framework pact-gov framework --create "Financial Services Framework" # Add regulations to framework pact-gov framework --add-regulation reg-a1b2c3d4e5f6 --framework "Financial Services Framework" # List all frameworks pact-gov framework --list ``` ## Public Consultation ### Engage Stakeholders ```bash # Open public consultation pact-gov consult --regulation reg-a1b2c3d4e5f6 --duration 60d # Check consultation status pact-gov consult --summary ``` Expected output: ``` ✓ Public consultation opened Regulation: reg-a1b2c3d4e5f6 Duration: 60 days End Date: 2024-10-01 Channels: website, email, public-forum Consultation ID: consult-g7h8i9j0k1l2 ``` ## Generate Reports ### Create Compliance Reports ```bash # Generate PDF compliance report pact-gov report --type compliance --format pdf --period 2024Q3 # Generate CSV enforcement report pact-gov report --type enforcement --format csv --output enforcement-q3.csv # Generate HTML impact assessment pact-gov report --type impact --format html --period 2024 ``` Expected output: ``` ✓ Report generated successfully Type: Compliance Report Period: 2024Q3 Format: PDF File: compliance-report-2024q3-20240801.pdf Size: 2.4 MB ``` ## Working with JSON Output All commands support JSON output for programmatic use: ```bash # Get regulation data as JSON pact-gov regulation view --id reg-a1b2c3d4e5f6 --json # Monitor compliance rates pact-gov status --json | jq '.overallComplianceRate' # Process audit results pact-gov audit --regulation all --json | jq '.findings[] | select(.severity == "high")' ``` ## Cryptographic Proofs Generate audit trails for all regulatory actions: ```bash # Create regulation with proof pact-gov regulation new --title "Data Protection Law" --type data --proof # Publish with proof pact-gov publish --regulation reg-a1b2c3d4e5f6 --proof # Enforce with proof pact-gov enforce --regulation reg-a1b2c3d4e5f6 --entity company-alpha --action warn --proof ``` Expected output with proof: ``` ✓ Regulation created successfully ID: reg-b2c3d4e5f6g7 Title: Data Protection Law Type: data Status: draft Proof: pact-proof-a1b2c3d4e5f6g7h8 ``` ## Common Workflows ### Complete Regulation Lifecycle ```bash #!/bin/bash # Complete regulatory workflow # 1. Create regulation REG_ID=$(pact-gov regulation new --title "Crypto Exchange Reporting" --type financial --json | jq -r '.regulation.id') # 2. Open consultation pact-gov consult --regulation "$REG_ID" --duration 45d echo "Consultation period: 45 days" echo "Continue after consultation closes..." # 3. Publish regulation pact-gov publish --regulation "$REG_ID" --effective "2024-12-01" # 4. Monitor compliance pact-gov audit --regulation "$REG_ID" --period 2024Q4 # 5. Generate report pact-gov report --type compliance --format pdf --period 2024Q4 ``` ### Multi-Regulation Framework ```bash #!/bin/bash # Create comprehensive regulatory framework # Create framework pact-gov framework --create "Digital Asset Regulatory Framework" # Create component regulations EXCHANGE_REG=$(pact-gov regulation new --title "Exchange Licensing Requirements" --type financial --json | jq -r '.regulation.id') CUSTODY_REG=$(pact-gov regulation new --title "Digital Asset Custody Standards" --type financial --json | jq -r '.regulation.id') MARKET_REG=$(pact-gov regulation new --title "Market Manipulation Prevention" --type financial --json | jq -r '.regulation.id') # Add to framework pact-gov framework --add-regulation "$EXCHANGE_REG" --framework "Digital Asset Regulatory Framework" pact-gov framework --add-regulation "$CUSTODY_REG" --framework "Digital Asset Regulatory Framework" pact-gov framework --add-regulation "$MARKET_REG" --framework "Digital Asset Regulatory Framework" # Publish all regulations for reg in "$EXCHANGE_REG" "$CUSTODY_REG" "$MARKET_REG"; do pact-gov publish --regulation "$reg" --effective "2025-01-01" done echo "Digital Asset Regulatory Framework created and published" ``` ### Automated Compliance Monitoring ```bash #!/bin/bash # Daily compliance monitoring script LOG_FILE="/var/log/pact-gov-compliance.log" DATE=$(date +%Y-%m-%d) echo "[$DATE] Starting compliance monitoring..." >> "$LOG_FILE" # Check overall compliance rate COMPLIANCE_RATE=$(pact-gov status --json | jq -r '.overallComplianceRate') if (( $(echo "$COMPLIANCE_RATE < 0.85" | bc -l) )); then echo "[$DATE] WARNING: Compliance rate below 85%: $COMPLIANCE_RATE" >> "$LOG_FILE" # Run immediate audit pact-gov audit --regulation all --period "$(date +%Y%m%d)" --json > "/tmp/emergency-audit-$DATE.json" # Identify high-risk violations HIGH_RISK=$(jq '.findings[] | select(.severity == "high") | .entity' "/tmp/emergency-audit-$DATE.json") # Automatic enforcement for critical violations while read -r entity; do if [ -n "$entity" ]; then echo "[$DATE] Issuing enforcement action for $entity" >> "$LOG_FILE" pact-gov enforce --regulation all --entity "$entity" --action warn --severity high fi done <<< "$HIGH_RISK" fi echo "[$DATE] Compliance monitoring complete" >> "$LOG_FILE" ``` ## Configuration Options ### Global Options Available for all commands: ```bash pact-gov --json # JSON output pact-gov --proof # Generate cryptographic proof pact-gov --verbose # Verbose output pact-gov --debug # Debug mode pact-gov --no-banner # Disable banner ``` ### Environment Configuration ```bash # Logging export PACT_LOG_LEVEL="debug" # debug, info, warn, error # Authority export PACT_GOVERNMENT_ID="regulatory-authority" export PACT_JURISDICTION="federal" # API Configuration export PACT_API_ENDPOINT="https://api.pact.protocol" export PACT_CONFIG_PATH="/path/to/config" ``` ## Troubleshooting ### Common Issues **Command not found:** ```bash # Ensure installation completed npm list -g pact-gov # Reinstall if needed npm install -g pact-gov ``` **Regulation not found:** ```bash # List all regulations pact-gov regulation list # Check regulation ID format pact-gov regulation view --id your-regulation-id ``` **Permission errors:** ```bash # Check configuration cat ~/.pactrc # Verify environment variables env | grep PACT ``` **Invalid date format:** ```bash # Use YYYY-MM-DD format pact-gov publish --regulation reg-123 --effective "2024-12-01" ``` ### Debug Mode Enable detailed logging: ```bash pact-gov --debug status ``` ### Get Help ```bash # General help pact-gov --help # Command-specific help pact-gov regulation --help pact-gov publish --help pact-gov enforce --help ``` ## Next Steps Now that you're up and running, explore these advanced topics: 1. **[API Reference](api-reference.md)** - Detailed command documentation 2. **[Architecture](architecture.md)** - System design and implementation 3. **[Regulatory Frameworks](regulatory-frameworks.md)** - Advanced framework management 4. **[Compliance Monitoring](compliance-monitoring.md)** - Automated monitoring strategies ### Advanced Workflows **Multi-Jurisdiction Coordination:** ```bash # Set jurisdiction-specific regulations export PACT_JURISDICTION="federal" pact-gov regulation new --title "Federal Anti-Money Laundering Rules" --type financial export PACT_JURISDICTION="state" pact-gov regulation new --title "State Consumer Protection Rules" --type data ``` **Stakeholder Engagement:** ```bash # Create regulation with extended consultation pact-gov regulation new --title "Cryptocurrency Taxation Framework" --type financial pact-gov consult --regulation crypto-tax-framework --duration 90d --channels "website,email,public-forum,town-halls" ``` **Impact Assessment:** ```bash # Generate comprehensive impact report pact-gov report --type impact --format html --period 2024 --output impact-assessment-2024.html ``` ## Support - **Documentation**: [docs.pact.protocol/gov](https://docs.pact.protocol/gov) - **GitHub Issues**: [github.com/pact-protocol/pact-gov/issues](https://github.com/pact-protocol/pact-gov/issues) - **Regulatory Support**: [regulatory-support@pact.protocol](mailto:regulatory-support@pact.protocol) - **Emergency Contacts**: Available in regulatory documentation --- You're now ready to start managing government regulatory operations with PACT Gov CLI! 🏛️