|
| 1 | +# HEM CLI |
| 2 | + |
| 3 | +The command-line interface for the **Hedonistic Method** (HEM) -- an AI-native creation methodology for governing agent-driven software projects. HEM provides structured governance, quality measurement, project validation, and multi-engine orchestration from your terminal. |
| 4 | + |
| 5 | +## Install |
| 6 | + |
| 7 | +```bash |
| 8 | +npm install -g @hedonistic-io/hem |
| 9 | +``` |
| 10 | + |
| 11 | +Or with a project-local install: |
| 12 | + |
| 13 | +```bash |
| 14 | +npm install --save-dev @hedonistic-io/hem |
| 15 | +npx hem --help |
| 16 | +``` |
| 17 | + |
| 18 | +## Commands |
| 19 | + |
| 20 | +### Project Setup |
| 21 | + |
| 22 | +```bash |
| 23 | +# Initialize a new HEM project in the current directory |
| 24 | +hem init |
| 25 | + |
| 26 | +# Initialize with a specific profile |
| 27 | +hem init --profile saas-product |
| 28 | + |
| 29 | +# Initialize in a target directory |
| 30 | +hem init ./my-project |
| 31 | + |
| 32 | +# Guided first-time setup wizard |
| 33 | +hem wizard |
| 34 | +``` |
| 35 | + |
| 36 | +### Daily Workflow |
| 37 | + |
| 38 | +```bash |
| 39 | +# Project health dashboard |
| 40 | +hem status |
| 41 | +hem status --json |
| 42 | + |
| 43 | +# Calculate the Hedonistic Index (quality score) |
| 44 | +hem measure |
| 45 | +hem measure quick |
| 46 | +hem measure --json |
| 47 | + |
| 48 | +# Run governance validation checks |
| 49 | +hem validate |
| 50 | +hem validate --json |
| 51 | +``` |
| 52 | + |
| 53 | +### Signing and Verification |
| 54 | + |
| 55 | +```bash |
| 56 | +# Sign a file with your HEM key |
| 57 | +hem sign file ./COMPACT.md |
| 58 | + |
| 59 | +# Verify a signed file |
| 60 | +hem sign verify ./COMPACT.md.sig |
| 61 | + |
| 62 | +# Manage signing keys |
| 63 | +hem sign keys |
| 64 | +hem sign generate |
| 65 | +``` |
| 66 | + |
| 67 | +### Estimation and Calibration |
| 68 | + |
| 69 | +```bash |
| 70 | +# View or adjust estimates |
| 71 | +hem estimate |
| 72 | + |
| 73 | +# Record actuals against estimates |
| 74 | +hem estimate actuals |
| 75 | + |
| 76 | +# View calibration data |
| 77 | +hem estimate calibration |
| 78 | + |
| 79 | +# Harvest calibration entries from completed tasks |
| 80 | +hem estimate harvest |
| 81 | +``` |
| 82 | + |
| 83 | +### AI Engine Orchestration |
| 84 | + |
| 85 | +```bash |
| 86 | +# List available AI engines (Claude, Codex, Gemini, etc.) |
| 87 | +hem engines |
| 88 | +hem engines available |
| 89 | + |
| 90 | +# Launch a sub-agent on a specific engine |
| 91 | +hem launch claude "Implement the auth module" |
| 92 | +``` |
| 93 | + |
| 94 | +### Skills |
| 95 | + |
| 96 | +```bash |
| 97 | +# List available HEM skills |
| 98 | +hem skills list |
| 99 | + |
| 100 | +# Show details for a specific skill |
| 101 | +hem skills info build |
| 102 | +``` |
| 103 | + |
| 104 | +### Changelog Management |
| 105 | + |
| 106 | +```bash |
| 107 | +# Show the changelog |
| 108 | +hem changelog show |
| 109 | + |
| 110 | +# Add an entry |
| 111 | +hem changelog add |
| 112 | + |
| 113 | +# Show the latest version entry |
| 114 | +hem changelog latest |
| 115 | +``` |
| 116 | + |
| 117 | +### Shell Completions |
| 118 | + |
| 119 | +```bash |
| 120 | +# Generate completions for your shell |
| 121 | +hem completions fish |
| 122 | +hem completions zsh |
| 123 | +hem completions bash |
| 124 | + |
| 125 | +# Auto-install completions |
| 126 | +hem completions install |
| 127 | +``` |
| 128 | + |
| 129 | +### MCP Server |
| 130 | + |
| 131 | +```bash |
| 132 | +# Start the HEM MCP server (stdio transport) |
| 133 | +hem serve |
| 134 | +``` |
| 135 | + |
| 136 | +### Active Monitoring |
| 137 | + |
| 138 | +```bash |
| 139 | +# Run the steering watchdog (continuous governance monitoring) |
| 140 | +hem watch |
| 141 | +hem watch --json |
| 142 | +``` |
| 143 | + |
| 144 | +### Additional Commands |
| 145 | + |
| 146 | +```bash |
| 147 | +# Manage tasks |
| 148 | +hem tasks list|add|complete|actuals|focus|progress |
| 149 | + |
| 150 | +# Manage compacts (project contracts) |
| 151 | +hem compact show|create|vision|scope|criteria|complete |
| 152 | + |
| 153 | +# Generate role-scoped briefs |
| 154 | +hem brief show|export --role steward --budget 4000 |
| 155 | + |
| 156 | +# Session memory management |
| 157 | +hem memory list|show|append|distill |
| 158 | + |
| 159 | +# Multi-project management |
| 160 | +hem projects list|add|remove|switch|scan |
| 161 | + |
| 162 | +# Profile management |
| 163 | +hem profile show|list|set|info |
| 164 | + |
| 165 | +# Escalation checks |
| 166 | +hem escalation check|thresholds |
| 167 | + |
| 168 | +# One-shot steering analysis |
| 169 | +hem steer analyze|prompt|check |
| 170 | + |
| 171 | +# Lint governance documents |
| 172 | +hem lint compact|tasks|accord|amendment |
| 173 | + |
| 174 | +# Rejection tracking |
| 175 | +hem reject list|create|resolve|summary |
| 176 | + |
| 177 | +# Knowledge base |
| 178 | +hem knowledge list|search|show|stages|add|corroborate |
| 179 | + |
| 180 | +# Archive management |
| 181 | +hem archive list|show|search|export |
| 182 | + |
| 183 | +# Template rendering |
| 184 | +hem template list|show|render |
| 185 | + |
| 186 | +# Version info |
| 187 | +hem version |
| 188 | +``` |
| 189 | + |
| 190 | +## How It Works |
| 191 | + |
| 192 | +HEM CLI wraps `@hedonistic-io/hem-core`, which provides: |
| 193 | + |
| 194 | +- **Profile system** -- per-project behavior profiles (saas-product, hardware, open-source, etc.) |
| 195 | +- **Hedonistic Index** -- a composite quality score measuring session health, steering quality, agent performance, and outcome quality |
| 196 | +- **Governance validation** -- checks for COMPACT.md, TASKS.md, proper git workflow, and method compliance |
| 197 | +- **Estimation calibration** -- track estimate-vs-actual ratios and improve future estimates |
| 198 | +- **Multi-engine orchestration** -- launch and manage agents across Claude, Codex, Gemini, Copilot, and more |
| 199 | +- **Cryptographic signing** -- sign and verify governance documents |
| 200 | + |
| 201 | +## Quality Priority |
| 202 | + |
| 203 | +HEM enforces a strict quality priority in all work: |
| 204 | + |
| 205 | +1. Correctness |
| 206 | +2. Security |
| 207 | +3. Simplicity |
| 208 | +4. Maintainability |
| 209 | +5. Performance |
| 210 | + |
| 211 | +## The Method |
| 212 | + |
| 213 | +The Hedonistic Method is a universal creation methodology built for AI-native development. It covers the full project lifecycle from genesis through integration, with structured governance that scales from solo projects to multi-agent orchestration. |
| 214 | + |
| 215 | +Learn more at the [method repository](https://github.com/hedonistic-io/method). |
| 216 | + |
| 217 | +## License |
| 218 | + |
| 219 | +MIT - Hedonistic IO LLC |
0 commit comments