Chkcompliance

Check Repository Compliance

Validates that the current repository meets Brockhoff Cloud spec-driven development standards. Reports which components are compliant and which need attention.

Usage

/bkff:chkcompliance
/bkff:chkcompliance --format=json

Compliance Checks

The following components are validated:

GitHub Configuration (.github/)

Agent Instructions

Beads Issue Tracking

Output

Human-Readable (default)

Compliance Report
─────────────────────────────────────
  ✓ github-dir
  ✓ github-codeowners
  ✗ github-contributing
    → File missing: .github/CONTRIBUTING.md
  ✓ agents-md
  ✓ claude-md
  ✓ beads-init
  ○ beads-health (skipped)
    → Beads not initialized
─────────────────────────────────────
2 check(s) failed (10 passed, 2 failed)

Run 'bkff:fixcompliance' to automatically fix issues

JSON Format

{
  "timestamp": "2026-01-24T10:30:00Z",
  "repository": "/path/to/repo",
  "overall_status": "fail",
  "checks_passed": 10,
  "checks_failed": 2,
  "checks_skipped": 1,
  "checks_total": 13,
  "checks": [
    {
      "name": "github-codeowners",
      "path": ".github/CODEOWNERS",
      "status": "pass",
      "message": null,
      "description": "Code review ownership rules",
      "remediation": "Create CODEOWNERS with team ownership patterns"
    }
  ]
}

Requirements

• Must be run inside a git repository
• jq for JSON processing
• bd CLI for beads health check (optional - gracefully skips if not available)

Exit Codes

• 0 - All checks passed
• 1 - One or more checks failed
• 2 - Not a git repository or other error

Related Skills

• /bkff:fixcompliance - Automatically fix compliance issues

Implementation

#!/usr/bin/env bash
set -euo pipefail

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
PLUGIN_DIR="$(dirname "$(dirname "$SCRIPT_DIR")")"
source "$PLUGIN_DIR/lib/common.sh"
source "$PLUGIN_DIR/lib/compliance.sh"

# Parse arguments
format="human"
for arg in "$@"; do
    case "$arg" in
        --format=json) format="json" ;;
        --format=human) format="human" ;;
        --json) format="json" ;;
    esac
done

# Validate git repository
if ! is_git_worktree; then
    error_exit "Not a git repository. This command must be run inside a git repository."
fi

# Run all compliance checks
report=$(run_all_checks)

# Output based on format
if [[ "$format" == "json" ]]; then
    echo "$report"
else
    echo "$report" | print_compliance_report
fi

# Exit with appropriate code
overall_status=$(echo "$report" | jq -r '.overall_status')
if [[ "$overall_status" == "pass" ]]; then
    exit 0
else
    exit 1
fi

Converted and distributed by TomeVault — claim your Tome and manage your conversions.