@paths.design/caws-cli 8.0.0 → 8.1.0

package/templates/.claude/README.md

@@ -0,0 +1,190 @@
+# Claude Code Integration for CAWS
+
+This directory contains Claude Code hooks and configuration for CAWS (Coding Agent Working Standard) integration.
+
+## Overview
+
+CAWS hooks for Claude Code provide:
+
+- **Safety Gates**: Block dangerous commands and scan for secrets
+- **Quality Gates**: Run CAWS quality checks after file edits
+- **Scope Guards**: Validate edits against the working spec's scope
+- **Audit Logging**: Track agent actions for compliance
+
+## Directory Structure
+
+```
+.claude/
+├── settings.json      # Claude Code settings with hooks configuration
+├── hooks/             # Hook scripts
+│   ├── audit.sh           # Session and action logging
+│   ├── block-dangerous.sh # Block destructive commands
+│   ├── scan-secrets.sh    # Warn when reading sensitive files
+│   ├── quality-check.sh   # Run CAWS quality gates
+│   ├── validate-spec.sh   # Validate spec files
+│   ├── scope-guard.sh     # Check scope boundaries
+│   └── naming-check.sh    # Validate file naming conventions
+├── logs/              # Audit logs (gitignored)
+└── README.md          # This file
+```
+
+## Hook Events
+
+### PreToolUse Hooks
+
+Run before Claude executes a tool:
+
+| Hook | Matcher | Purpose |
+|------|---------|---------|
+| `block-dangerous.sh` | `Bash` | Block destructive shell commands |
+| `scan-secrets.sh` | `Read` | Warn when reading sensitive files |
+| `scope-guard.sh` | `Write\|Edit` | Check scope boundaries before edits |
+
+### PostToolUse Hooks
+
+Run after Claude executes a tool:
+
+| Hook | Matcher | Purpose |
+|------|---------|---------|
+| `quality-check.sh` | `Write\|Edit` | Run CAWS quality gates |
+| `validate-spec.sh` | `Write\|Edit` | Validate spec file changes |
+| `naming-check.sh` | `Write` | Check file naming conventions |
+| `audit.sh` | `Write\|Edit\|Bash` | Log tool usage |
+
+### Session Hooks
+
+| Hook | Event | Purpose |
+|------|-------|---------|
+| `audit.sh session-start` | `SessionStart` | Log session start |
+| `audit.sh stop` | `Stop` | Log session end |
+
+## Configuration
+
+### Enable/Disable Hooks
+
+Edit `settings.json` to enable or disable specific hooks. Remove entries from the `hooks` object to disable them.
+
+### Hook Levels
+
+The scaffold supports four hook levels:
+
+- **safety**: Block dangerous commands, scan for secrets
+- **quality**: Run quality gates on file edits
+- **scope**: Validate edits against spec scope
+- **audit**: Log all agent actions
+
+Run `caws init --hooks=safety,quality` to enable specific levels.
+
+## Audit Logs
+
+Audit logs are written to `.claude/logs/`:
+
+- `audit.log` - All-time log (appended)
+- `audit-YYYY-MM-DD.log` - Daily logs
+
+Logs are JSON-formatted for easy parsing:
+
+```json
+{
+  "timestamp": "2024-01-15T10:30:00Z",
+  "session_id": "abc123",
+  "event": "tool_use",
+  "tool": "Write",
+  "file": "src/index.ts",
+  "cwd": "/project"
+}
+```
+
+## Customization
+
+### Adding Custom Hooks
+
+1. Create a new script in `.claude/hooks/`
+2. Make it executable: `chmod +x .claude/hooks/my-hook.sh`
+3. Add it to `settings.json`:
+
+```json
+{
+  "hooks": {
+    "PostToolUse": [
+      {
+        "matcher": "Write|Edit",
+        "hooks": [
+          {
+            "type": "command",
+            "command": "\"$CLAUDE_PROJECT_DIR\"/.claude/hooks/my-hook.sh",
+            "timeout": 10
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
+### Hook Input/Output
+
+Hooks receive JSON input via stdin:
+
+```json
+{
+  "session_id": "abc123",
+  "hook_event_name": "PostToolUse",
+  "tool_name": "Write",
+  "tool_input": {
+    "file_path": "/path/to/file.ts",
+    "content": "..."
+  },
+  "tool_response": { "success": true }
+}
+```
+
+Hooks can output JSON to control Claude's behavior:
+
+```json
+{
+  "decision": "block",
+  "reason": "Quality gate failed: ..."
+}
+```
+
+Or add context:
+
+```json
+{
+  "hookSpecificOutput": {
+    "hookEventName": "PostToolUse",
+    "additionalContext": "Remember to update the tests."
+  }
+}
+```
+
+## Troubleshooting
+
+### Hooks Not Running
+
+1. Check `settings.json` syntax: `cat .claude/settings.json | jq .`
+2. Verify scripts are executable: `ls -la .claude/hooks/`
+3. Test hooks manually: `echo '{}' | .claude/hooks/audit.sh`
+
+### Permission Errors
+
+Make all hook scripts executable:
+
+```bash
+chmod +x .claude/hooks/*.sh
+```
+
+### Debug Hooks
+
+Run Claude Code with `--debug` to see hook execution details:
+
+```bash
+claude --debug
+```
+
+## Further Reading
+
+- [Claude Code Hooks Documentation](https://code.claude.com/docs/en/hooks)
+- [CAWS Quality Gates](../../docs/quality-gates.md)
+- [CAWS Scope Management](../../docs/scope-management.md)

package/templates/.claude/hooks/audit.sh

@@ -0,0 +1,96 @@
+#!/bin/bash
+# CAWS Audit Hook for Claude Code
+# Logs agent actions for compliance and debugging
+# @author @darianrosebrook
+
+set -euo pipefail
+
+# Get event type from argument or input
+EVENT_TYPE="${1:-tool-use}"
+
+# Read JSON input from stdin
+INPUT=$(cat)
+
+# Parse common fields from Claude Code hook input
+SESSION_ID=$(echo "$INPUT" | jq -r '.session_id // "unknown"')
+CWD=$(echo "$INPUT" | jq -r '.cwd // "."')
+HOOK_EVENT=$(echo "$INPUT" | jq -r '.hook_event_name // "unknown"')
+TOOL_NAME=$(echo "$INPUT" | jq -r '.tool_name // ""')
+PERMISSION_MODE=$(echo "$INPUT" | jq -r '.permission_mode // "default"')
+
+# Ensure log directory exists
+LOG_DIR="${CLAUDE_PROJECT_DIR:-.}/.claude/logs"
+mkdir -p "$LOG_DIR"
+
+# Log file path
+LOG_FILE="$LOG_DIR/audit.log"
+DATE_LOG_FILE="$LOG_DIR/audit-$(date +%Y-%m-%d).log"
+
+# Timestamp
+TIMESTAMP=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
+
+# Build log entry based on event type
+case "$EVENT_TYPE" in
+  session-start)
+    SOURCE=$(echo "$INPUT" | jq -r '.source // "unknown"')
+    MODEL=$(echo "$INPUT" | jq -r '.model // "unknown"')
+    LOG_ENTRY=$(jq -n \
+      --arg ts "$TIMESTAMP" \
+      --arg sid "$SESSION_ID" \
+      --arg event "session_start" \
+      --arg source "$SOURCE" \
+      --arg model "$MODEL" \
+      --arg cwd "$CWD" \
+      '{timestamp: $ts, session_id: $sid, event: $event, source: $source, model: $model, cwd: $cwd}')
+    ;;
+
+  stop)
+    STOP_HOOK_ACTIVE=$(echo "$INPUT" | jq -r '.stop_hook_active // false')
+    LOG_ENTRY=$(jq -n \
+      --arg ts "$TIMESTAMP" \
+      --arg sid "$SESSION_ID" \
+      --arg event "session_stop" \
+      --arg cwd "$CWD" \
+      --argjson hook_active "$STOP_HOOK_ACTIVE" \
+      '{timestamp: $ts, session_id: $sid, event: $event, cwd: $cwd, stop_hook_active: $hook_active}')
+    ;;
+
+  tool-use)
+    # Extract tool-specific info
+    TOOL_INPUT=$(echo "$INPUT" | jq -c '.tool_input // {}')
+    TOOL_RESPONSE=$(echo "$INPUT" | jq -c '.tool_response // {}')
+    TOOL_USE_ID=$(echo "$INPUT" | jq -r '.tool_use_id // ""')
+
+    # For file operations, extract the path
+    FILE_PATH=$(echo "$TOOL_INPUT" | jq -r '.file_path // ""')
+    COMMAND=$(echo "$TOOL_INPUT" | jq -r '.command // ""')
+
+    LOG_ENTRY=$(jq -n \
+      --arg ts "$TIMESTAMP" \
+      --arg sid "$SESSION_ID" \
+      --arg event "tool_use" \
+      --arg tool "$TOOL_NAME" \
+      --arg file "$FILE_PATH" \
+      --arg cmd "$COMMAND" \
+      --arg cwd "$CWD" \
+      --arg mode "$PERMISSION_MODE" \
+      '{timestamp: $ts, session_id: $sid, event: $event, tool: $tool, file: $file, command: $cmd, cwd: $cwd, permission_mode: $mode}')
+    ;;
+
+  *)
+    LOG_ENTRY=$(jq -n \
+      --arg ts "$TIMESTAMP" \
+      --arg sid "$SESSION_ID" \
+      --arg event "$EVENT_TYPE" \
+      --arg hook "$HOOK_EVENT" \
+      --arg cwd "$CWD" \
+      '{timestamp: $ts, session_id: $sid, event: $event, hook_event: $hook, cwd: $cwd}')
+    ;;
+esac
+
+# Append to log files
+echo "$LOG_ENTRY" >> "$LOG_FILE"
+echo "$LOG_ENTRY" >> "$DATE_LOG_FILE"
+
+# Success - allow operation to continue
+exit 0

package/templates/.claude/hooks/block-dangerous.sh

@@ -0,0 +1,90 @@
+#!/bin/bash
+# CAWS Dangerous Command Blocker for Claude Code
+# Blocks potentially destructive shell commands
+# @author @darianrosebrook
+
+set -euo pipefail
+
+# Read JSON input from Claude Code
+INPUT=$(cat)
+
+# Extract tool info
+TOOL_NAME=$(echo "$INPUT" | jq -r '.tool_name // ""')
+COMMAND=$(echo "$INPUT" | jq -r '.tool_input.command // ""')
+
+# Only check Bash tool
+if [[ "$TOOL_NAME" != "Bash" ]] || [[ -z "$COMMAND" ]]; then
+  exit 0
+fi
+
+# Dangerous command patterns
+DANGEROUS_PATTERNS=(
+  # Destructive file operations
+  'rm -rf /'
+  'rm -rf ~'
+  'rm -rf \*'
+  'rm -rf \.'
+  'rm -rf /\*'
+  'dd if=/dev/zero'
+  'dd if=/dev/random'
+  'mkfs\.'
+  'fdisk'
+  '> /dev/sd'
+
+  # Fork bombs and resource exhaustion
+  ':\(\)\{:\|:\&\};:'
+  'while true.*fork'
+
+  # Credential/secret exposure
+  'cat.*\.env'
+  'cat.*/etc/passwd'
+  'cat.*/etc/shadow'
+  'cat.*id_rsa'
+  'cat.*\.ssh/'
+  'cat.*credentials'
+  'cat.*\.aws/'
+
+  # Network exfiltration
+  'curl.*\|.*sh'
+  'wget.*\|.*sh'
+  'curl.*\|.*bash'
+  'wget.*\|.*bash'
+
+  # Permission escalation
+  'chmod 777'
+  'chmod -R 777'
+  'chmod.*\+s'
+
+  # History manipulation
+  'history -c'
+  'rm.*\.bash_history'
+  'rm.*\.zsh_history'
+
+  # System modification
+  'shutdown'
+  'reboot'
+  'init 0'
+  'init 6'
+)
+
+# Check command against dangerous patterns
+for pattern in "${DANGEROUS_PATTERNS[@]}"; do
+  if echo "$COMMAND" | grep -qiE "$pattern"; then
+    # Output to stderr for Claude to see
+    echo "BLOCKED: Command matches dangerous pattern: $pattern" >&2
+    echo "Command was: $COMMAND" >&2
+
+    # Exit code 2 blocks the tool and shows stderr to Claude
+    exit 2
+  fi
+done
+
+# Check for sudo without specific allowed commands
+if echo "$COMMAND" | grep -qE '^sudo\s' && ! echo "$COMMAND" | grep -qE 'sudo (npm|yarn|pnpm|brew|apt-get|apt|dnf|yum)'; then
+  echo "BLOCKED: sudo commands require explicit approval" >&2
+  echo "If this command is safe, please run it manually in your terminal" >&2
+  exit 2
+fi
+
+# Allow the command
+exit 0

package/templates/.claude/hooks/naming-check.sh

@@ -0,0 +1,97 @@
+#!/bin/bash
+# CAWS Naming Convention Check Hook for Claude Code
+# Validates file naming against CAWS conventions
+# @author @darianrosebrook
+
+set -euo pipefail
+
+# Read JSON input from Claude Code
+INPUT=$(cat)
+
+# Extract file path from PostToolUse input
+FILE_PATH=$(echo "$INPUT" | jq -r '.tool_input.file_path // ""')
+TOOL_NAME=$(echo "$INPUT" | jq -r '.tool_name // ""')
+
+# Only check Write tool (new files)
+if [[ "$TOOL_NAME" != "Write" ]]; then
+  exit 0
+fi
+
+if [[ -z "$FILE_PATH" ]]; then
+  exit 0
+fi
+
+# Get filename
+FILENAME=$(basename "$FILE_PATH")
+
+# Banned modifiers that indicate incomplete/temporary naming
+BANNED_MODIFIERS=(
+  "enhanced"
+  "unified"
+  "simplified"
+  "better"
+  "new"
+  "next"
+  "final"
+  "copy"
+  "revamp"
+  "improved"
+  "alt"
+  "tmp"
+  "scratch"
+  "wip"
+  "test-"
+  "-test"
+  "_test"
+  "temp"
+  "old"
+  "backup"
+)
+
+# Convert filename to lowercase for checking
+FILENAME_LOWER=$(echo "$FILENAME" | tr '[:upper:]' '[:lower:]')
+
+# Check for banned modifiers
+for modifier in "${BANNED_MODIFIERS[@]}"; do
+  if [[ "$FILENAME_LOWER" == *"$modifier"* ]]; then
+    # Special case: allow test files that follow conventions
+    if [[ "$modifier" == "test-" ]] || [[ "$modifier" == "-test" ]] || [[ "$modifier" == "_test" ]]; then
+      if [[ "$FILENAME_LOWER" =~ \.(test|spec)\.(js|ts|jsx|tsx|py|go|rs)$ ]]; then
+        continue
+      fi
+    fi
+
+    echo '{
+      "hookSpecificOutput": {
+        "hookEventName": "PostToolUse",
+        "additionalContext": "Warning: The filename '\'''"$FILENAME"''\'' contains the modifier '\'''"$modifier"''\'' which may indicate temporary or non-canonical naming. Consider using a more descriptive, permanent name. See CAWS naming conventions in .caws/canonical-map.yaml or run '\''caws naming check'\''."
+      }
+    }'
+    exit 0
+  fi
+done
+
+# Check for version suffixes (e.g., file-v2.js, file_v3.ts)
+if [[ "$FILENAME_LOWER" =~ [-_]v[0-9]+\. ]]; then
+  echo '{
+    "hookSpecificOutput": {
+      "hookEventName": "PostToolUse",
+      "additionalContext": "Warning: The filename '\'''"$FILENAME"''\'' contains a version suffix. Version control should be handled by git, not file names. Consider removing the version suffix."
+    }
+  }'
+  exit 0
+fi
+
+# Check for date stamps (e.g., file-2024-01-15.js)
+if [[ "$FILENAME_LOWER" =~ [0-9]{4}[-_][0-9]{2}[-_][0-9]{2} ]]; then
+  echo '{
+    "hookSpecificOutput": {
+      "hookEventName": "PostToolUse",
+      "additionalContext": "Warning: The filename '\'''"$FILENAME"''\'' contains a date stamp. Version control should be handled by git, not file names. Consider removing the date."
+    }
+  }'
+  exit 0
+fi
+
+# File naming is OK
+exit 0

package/templates/.claude/hooks/quality-check.sh

@@ -0,0 +1,68 @@
+#!/bin/bash
+# CAWS Quality Check Hook for Claude Code
+# Runs CAWS quality validation after file edits
+# @author @darianrosebrook
+
+set -euo pipefail
+
+# Read JSON input from Claude Code
+INPUT=$(cat)
+
+# Extract file info from PostToolUse input
+FILE_PATH=$(echo "$INPUT" | jq -r '.tool_input.file_path // ""')
+TOOL_NAME=$(echo "$INPUT" | jq -r '.tool_name // ""')
+
+# Only run on Write/Edit of source files
+if [[ "$TOOL_NAME" != "Write" ]] && [[ "$TOOL_NAME" != "Edit" ]]; then
+  exit 0
+fi
+
+# Skip non-source files and node_modules/dist
+if [[ ! "$FILE_PATH" =~ \.(js|ts|jsx|tsx|py|go|rs|java|mjs|cjs)$ ]] || \
+   [[ "$FILE_PATH" =~ node_modules ]] || \
+   [[ "$FILE_PATH" =~ dist/ ]] || \
+   [[ "$FILE_PATH" =~ build/ ]]; then
+  exit 0
+fi
+
+# Determine project directory
+PROJECT_DIR="${CLAUDE_PROJECT_DIR:-.}"
+
+# Check if we're in a CAWS project
+if [[ ! -f "$PROJECT_DIR/.caws/working-spec.yaml" ]]; then
+  exit 0
+fi
+
+# Check if CAWS CLI is available
+if ! command -v caws &> /dev/null; then
+  # Suggest installing CAWS
+  echo '{
+    "hookSpecificOutput": {
+      "hookEventName": "PostToolUse",
+      "additionalContext": "CAWS CLI not available. Consider installing with: npm install -g @caws/cli"
+    }
+  }'
+  exit 0
+fi
+
+# Run CAWS quality gates in quiet mode for quick feedback
+if caws quality-gates --context=commit --quiet 2>/dev/null; then
+  # Quality check passed - provide positive feedback
+  echo '{
+    "hookSpecificOutput": {
+      "hookEventName": "PostToolUse",
+      "additionalContext": "Quality gates passed for this change."
+    }
+  }'
+else
+  # Quality check failed - provide feedback to Claude
+  # Run again to get violations summary
+  VIOLATIONS=$(caws quality-gates --context=commit --json 2>/dev/null | jq -r '.violations[:3] | .[] | "- \(.gate): \(.message)"' 2>/dev/null || echo "Run 'caws quality-gates' for details")
+
+  echo '{
+    "decision": "block",
+    "reason": "Quality gate violations detected. Please address the following issues before continuing:\n'"$VIOLATIONS"'\n\nRun '\''caws quality-gates'\'' for full details."
+  }'
+fi
+
+exit 0

package/templates/.claude/hooks/scan-secrets.sh

@@ -0,0 +1,85 @@
+#!/bin/bash
+# CAWS Secret Scanner for Claude Code
+# Warns when reading files that may contain secrets
+# @author @darianrosebrook
+
+set -euo pipefail
+
+# Read JSON input from Claude Code
+INPUT=$(cat)
+
+# Extract file path
+FILE_PATH=$(echo "$INPUT" | jq -r '.tool_input.file_path // ""')
+
+if [[ -z "$FILE_PATH" ]]; then
+  exit 0
+fi
+
+# Get just the filename for pattern matching
+FILENAME=$(basename "$FILE_PATH")
+
+# Files that commonly contain secrets
+SECRET_FILE_PATTERNS=(
+  '.env'
+  '.env.local'
+  '.env.production'
+  '.env.development'
+  '.env.*'
+  'credentials.json'
+  'service-account.json'
+  'secrets.yaml'
+  'secrets.yml'
+  'secrets.json'
+  '.netrc'
+  '.npmrc'
+  '.pypirc'
+  'id_rsa'
+  'id_ed25519'
+  'id_ecdsa'
+  '*.pem'
+  '*.key'
+  '*.p12'
+  '*.pfx'
+  'htpasswd'
+  'shadow'
+)
+
+# Directories that commonly contain secrets
+SECRET_DIRS=(
+  '.ssh'
+  '.aws'
+  '.azure'
+  '.gcloud'
+  '.kube'
+  '.gnupg'
+)
+
+# Check if file matches secret patterns
+for pattern in "${SECRET_FILE_PATTERNS[@]}"; do
+  if [[ "$FILENAME" == $pattern ]]; then
+    # Output JSON with warning for Claude
+    echo '{
+      "hookSpecificOutput": {
+        "hookEventName": "PreToolUse",
+        "additionalContext": "WARNING: This file may contain secrets. Do not include sensitive values in your response. If you need to reference credentials, use placeholders like <API_KEY> instead of actual values."
+      }
+    }'
+    exit 0
+  fi
+done
+
+# Check if file is in a sensitive directory
+for dir in "${SECRET_DIRS[@]}"; do
+  if [[ "$FILE_PATH" == *"/$dir/"* ]] || [[ "$FILE_PATH" == *"/$dir" ]]; then
+    echo '{
+      "hookSpecificOutput": {
+        "hookEventName": "PreToolUse",
+        "additionalContext": "WARNING: This file is in a sensitive directory that may contain secrets. Do not include any sensitive values in your response."
+      }
+    }'
+    exit 0
+  fi
+done
+
+# Allow the read
+exit 0