|
| 1 | +hawk is an AI coding agent that reads, writes, and runs code in your terminal. |
| 2 | + |
| 3 | +Usage: |
| 4 | + hawk [prompt] [flags] |
| 5 | + hawk [command] |
| 6 | + |
| 7 | +Available Commands: |
| 8 | + acp Run hawk as an Agent Client Protocol (ACP) server |
| 9 | + agent Manage custom agent personas |
| 10 | + attach Attach to a running background session |
| 11 | + audit Analyze past sessions for wasteful patterns |
| 12 | + bg Run a session in the background |
| 13 | + completion Generate shell completion script |
| 14 | + config Show or update settings |
| 15 | + context Export project context as a single document for use in any LLM |
| 16 | + cost [Experimental] Analyze and optimize LLM API spend |
| 17 | + credentials Manage secure API key storage (macOS Keychain / Linux secret service) |
| 18 | + daemon Manage the hawk background server |
| 19 | + doctor Run local diagnostics |
| 20 | + ecosystem Show eyrie, yaad, and tok integration status |
| 21 | + eval Evaluate model performance on coding benchmarks |
| 22 | + exec Execute a single command non-interactively |
| 23 | + feedback Submit feedback about hawk |
| 24 | + fingerprint Generate a repository fingerprint (languages, deps, git info) |
| 25 | + help Help about any command |
| 26 | + history Search and browse command history |
| 27 | + inspect Scan a website for broken links, security issues, accessibility violations, and more |
| 28 | + mcp Show MCP server configuration |
| 29 | + mission Run a multi-agent mission (parallel feature execution) |
| 30 | + models Deployment-aware model catalog (via eyrie) |
| 31 | + path Developer path readiness (setup, security, sandbox, ecosystem) |
| 32 | + plan Create and manage structured development plans |
| 33 | + plugin Manage plugins |
| 34 | + pr AI-powered pull request workflow |
| 35 | + preflight Check hawk is ready to chat (catalog, credentials, model) |
| 36 | + recover Scan for interrupted sessions and resume |
| 37 | + research Autonomous research loop (Karpathy autoresearch pattern) |
| 38 | + review Continuous AI code review on commits |
| 39 | + rules Detect, import, and export AI coding rules between tool formats |
| 40 | + sandbox View, apply, or discard pending diff sandbox changes |
| 41 | + schema Output JSON schema for hawk settings.json |
| 42 | + search Search across saved sessions |
| 43 | + sessions List saved sessions |
| 44 | + setup Run first-time setup again |
| 45 | + sight AI-powered code review on the current branch diff |
| 46 | + skills Manage skills (list, search, install, remove, audit, info, trending) |
| 47 | + snapshot Manage file snapshots (undo any change) |
| 48 | + stats Show usage statistics and cost analytics |
| 49 | + taste Manage taste profile (learned coding style preferences) |
| 50 | + tools List built-in tools |
| 51 | + trace Git-native session capture — rewind, checkpoint, and audit AI sessions |
| 52 | + version Print hawk version |
| 53 | + yaad Yaad persistent memory graph |
| 54 | + |
| 55 | +Flags: |
| 56 | + --add-dir stringArray additional directories to include in session context |
| 57 | + --allow-project-mcp allow MCP servers defined in project-level .hawk/settings.json (security risk) |
| 58 | + --allowed-tools stringArray comma or space-separated tool permission rules to allow (e.g. "Bash(git:*) Edit") |
| 59 | + --append-system-prompt string append text to the default or custom system prompt |
| 60 | + --append-system-prompt-file string read text from a file and append it to the system prompt |
| 61 | + --auto-commit auto-commit file changes made by Write and Edit tools |
| 62 | + --auto-skill auto-detect project and install matching skills |
| 63 | + --container force container mode even if auto-detection would skip it |
| 64 | + -c, --continue continue the most recent conversation in the current directory |
| 65 | + --council consult multiple models and synthesize best answer |
| 66 | + --dangerously-skip-permissions bypass all permission checks |
| 67 | + --disallowed-tools stringArray comma or space-separated tool permission rules to deny (e.g. "Bash(git:*) Edit") |
| 68 | + --fork-session when resuming, create a new session ID instead of reusing the original |
| 69 | + -h, --help help for hawk |
| 70 | + --input-format string input format for --print: "text" or "stream-json" (default "text") |
| 71 | + --max-budget-usd float maximum estimated API spend in USD |
| 72 | + --max-turns int maximum number of agentic turns in non-interactive mode |
| 73 | + --mcp stringArray MCP server command |
| 74 | + -m, --model string model to use (from eyrie catalog; see /models) |
| 75 | + --no-auto-catalog-refresh disable automatic catalog refresh when cache is missing, empty, or stale |
| 76 | + --no-container disable container mode (run on host with permission prompts) |
| 77 | + --no-session-persistence disable session persistence in print mode |
| 78 | + --output-format string output format for --print: "text", "json", or "stream-json" (default "text") |
| 79 | + --permission-mode string permission mode: default, acceptEdits, bypassPermissions, dontAsk, or plan |
| 80 | + --power int power level 1-10 (auto-configures model, context, review depth) (default 5) |
| 81 | + -p, --print print response and exit |
| 82 | + --prompt string send a single prompt and exit (legacy alias for --print) |
| 83 | + --provider string LLM provider (anthropic, openai, gemini, etc.) |
| 84 | + --recover scan for interrupted sessions and offer to resume |
| 85 | + --refresh-catalog refresh the eyrie model catalog before starting |
| 86 | + -r, --resume string resume a saved session by ID |
| 87 | + --sandbox string Bash permission profile: strict, workspace, or off (not Docker; see --no-container) |
| 88 | + --session-id string use a specific session ID for the conversation |
| 89 | + --settings string path to a settings JSON file or a JSON string to load for this session |
| 90 | + --system-prompt string system prompt to use for the session |
| 91 | + --system-prompt-file string read system prompt from a file |
| 92 | + --teach explain reasoning as the agent works |
| 93 | + --teach-depth int explanation depth: 1=what, 2=why, 3=how (default 2) |
| 94 | + --timeout duration time budget for the operation (e.g., 2m, 5m, 1h) |
| 95 | + --tools stringArray available tools: "" disables all tools, "default" enables all, or names like "Bash,Edit,Read" |
| 96 | + -v, --version output the version number |
| 97 | + --vibe vibe coding mode: auto-apply, auto-run, no confirmations |
| 98 | + --watch watch the working directory for file changes |
| 99 | + |
| 100 | +Use "hawk [command] --help" for more information about a command. |
0 commit comments