Skip to content

Latest commit

 

History

History
148 lines (105 loc) · 5.78 KB

File metadata and controls

148 lines (105 loc) · 5.78 KB
 _                 _            _
| |__   ___   ___ | | ____      _(_)___  ___
| '_ \ / _ \ / _ \| |/ /\ \ /\ / / / __|/ _ \
| | | | (_) | (_) |   <  \ V  V /| \__ \  __/
|_| |_|\___/ \___/|_|\_\  \_/\_/ |_|___/\___|

One YAML file to guard, coach, and observe your Claude Code sessions.

npm version CI MIT License

hookwise TUI — Claude Code usage insights with session metrics, trends, and tool breakdown
hookwise TUI — your Claude Code usage at a glance

Why hookwise?

Claude Code hooks are powerful but raw -- bash scripts, no testing, no sharing. hookwise is one YAML file: declarative guards, testable rules, shareable recipes. If hookwise errors, it fails open -- your AI keeps working.

Guard rails should be boring. The exciting part is what you build when you are not worried about what your AI is doing.

Without hookwise

# .claude/settings.json — one script per guard, scattered across your project
"PreToolUse": [{ "command": "bash scripts/check-rm.sh" }]

# scripts/check-rm.sh  (repeat for every rule...)
#!/bin/bash
INPUT=$(cat)
CMD=$(echo "$INPUT" | jq -r '.tool_input.command // ""')
if echo "$CMD" | grep -q "rm -rf"; then
  echo '{"decision":"block","reason":"dangerous"}'
fi

With hookwise

# hookwise.yaml — add a rule, remove a rule, done
guards:
  - match: "Bash"
    action: block
    when: 'tool_input.command contains "rm -rf"'
    reason: "Dangerous command blocked"

One file. Claude Code reads it, understands it, and can even help you write new rules. No bash scripts to debug.

How It Compares

hookwise Raw hook scripts Status line tools
Guard rails Declarative YAML Manual bash No
Testing GuardTester + HookRunner Manual N/A
Coaching Metacognition prompts No No
Analytics SQLite, queryable DIY Display-only
Configuration One YAML file Scattered scripts JSON/TUI
Recipes 12 built-in, shareable N/A N/A
Cost tracking Budgets + alerts DIY Current session only

Quick Start

npm install -g hookwise
hookwise init --preset minimal
hookwise doctor
hookwise doctor output

Then register hookwise in .claude/settings.json — one dispatcher handles all 13 hook events.

What You Get

Guard Rails -- Declarative rules with firewall semantics. block or warn with glob patterns and operators like contains, matches, starts_with.

Guard blocking a dangerous rm -rf

Coaching -- Periodic metacognition prompts break autopilot mode: "Are you solving the right problem, or the most interesting one?"

Status Line -- 21 composable segments powered by a background daemon with 8 built-in feed producers. Mix session, cost, project, calendar, news, insights, and more.

Claude Code status line with context bar, cost, duration, and insights

Analytics -- SQLite-backed session tracking: tool calls, duration, cost, daily budgets.

hookwise stats

Interactive TUI -- Full-screen dashboard with 8 tabs: guards, coaching, analytics, feeds, insights, recipes, status. Run hookwise tui.

hookwise TUI — guard rules table

Configuration

Everything lives in hookwise.yaml. Four presets: minimal, coaching, analytics, full. Full reference →

version: 1
guards:
  - match: "Bash"
    action: block
    when: 'tool_input.command contains "rm -rf"'
    reason: "Dangerous command blocked"
coaching:
  metacognition: { enabled: true, interval_seconds: 300 }
analytics: { enabled: true }
status_line: { enabled: true, segments: [session, cost, project, calendar] }

Testing

import { GuardTester } from "hookwise/testing";
const tester = new GuardTester("hookwise.yaml");
expect(tester.evaluate("Bash", { command: "rm -rf /" }).action).toBe("block");

Also exports HookRunner and HookResult. Details →

Recipes

12 built-in -- see all or create your own: block-dangerous-commands, metacognition-prompts, commit-without-tests, and more.

Documentation

Guide Reference
Getting Started Guards
Creating a Recipe Coaching
Architecture Feeds
Philosophy Status Line
CLI Reference Analytics

Contributing

git clone, npm install, npm test (1,487 tests), npm run build. See CONTRIBUTING.md.

MIT -- Built by Vishnu. Born from watching Claude Code do amazing things -- and occasionally terrifying things.