Skip to content

cli.md

Latest commit

 

History

History
96 lines (66 loc) · 3.04 KB

cli.md

File metadata and controls

96 lines (66 loc) · 3.04 KB
Raw

CLI Commands

All commands are invoked as hookwise <command>.

Commands

hookwise init [--preset minimal|coaching|analytics|full]
                          Generate hookwise.yaml and state directory

hookwise doctor           Health check: config, state dir, handlers
hookwise doctor output 
hookwise status           Show current configuration summary
hookwise status output showing guards, coaching, features, and feeds 
hookwise stats            Session analytics: tool calls, duration, cost

hookwise test             Run guard rule tests against scenarios

hookwise tui              Launch the interactive TUI for config management

hookwise feeds [--once]   Live feed dashboard: daemon status, feed health, cache bus
                          Auto-refreshes every 3s; press q to quit. Use --once for snapshot.

hookwise setup <target>   Set up external integrations (e.g., hookwise setup calendar)

hookwise daemon <start|stop|status>
                          Manage the background feed daemon

hookwise migrate          Migrate from Python hookwise (v0.1.0) to TypeScript

Presets

Preset What you get
minimal Guards only -- just the safety rails
coaching Guards + metacognition + builder's trap + communication
analytics Guards + SQLite session tracking
full Everything enabled

Testing Utilities

hookwise includes testing utilities so you can validate guards in CI:

import { GuardTester } from "hookwise/testing";

const tester = new GuardTester({ configPath: "hookwise.yaml" });

// Test blocking
const blocked = tester.testToolCall("Bash", { command: "rm -rf /" });
expect(blocked.action).toBe("block");

// Test allowing
const allowed = tester.testToolCall("Bash", { command: "ls -la" });
expect(allowed.action).toBe("allow");

Three testing utilities are exported:

  • GuardTester -- In-process guard rule evaluation (fast, no subprocess)
  • HookRunner -- Subprocess-based hook execution (tests the real dispatch path)
  • HookResult -- Assertion helpers (assertBlocked(), assertAllowed(), assertWarns())

Interactive TUI

Full-screen terminal UI built with Python Textual -- 8 tabs:

Key Tab Description
1 Dashboard Feature overview with enabled/disabled status
2 Guards Guard rules table with action descriptions
3 Coaching Coaching features with user-friendly explanations
4 Analytics Sparkline trends, tool breakdown, cost tracking
5 Feeds Live feed dashboard with auto-refresh and health indicators
6 Insights Claude Code usage metrics, trends, and daily AI summary
7 Recipes Recipe browser grouped by category
8 Status Status line preview and segment configurator

Press q to exit the TUI. Install: cd tui && pip install -e .

← Back to Home