Documentation
¶
There is no documentation for this package.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api provides an HTTP API server for hawk, consumable by SDKs.
|
Package api provides an HTTP API server for hawk, consumable by SDKs. |
|
Package circuit provides a circuit breaker pattern for resilience.
|
Package circuit provides a circuit breaker pattern for resilience. |
|
compat-test
command
compat-test reads compatibility-matrix.json and runs basic compatibility checks across the listed components.
|
compat-test reads compatibility-matrix.json and runs basic compatibility checks across the listed components. |
|
Package cmdhistory implements a structured command history store using SQLite.
|
Package cmdhistory implements a structured command history store using SQLite. |
|
Package validator provides config validation utilities.
|
Package validator provides config validation utilities. |
|
Package container provides Docker container lifecycle management for hawk's sandboxed execution environments.
|
Package container provides Docker container lifecycle management for hawk's sandboxed execution environments. |
|
Package daemon provides a Telegram gateway for hawk.
|
Package daemon provides a Telegram gateway for hawk. |
|
agent
Package agent is the Stage-1 namespace for sub-agent orchestration types.
|
Package agent is the Stage-1 namespace for sub-agent orchestration types. |
|
branching
Package branching is the Stage-1 namespace for branching strategies, cascade, council, shadow, snowball.
|
Package branching is the Stage-1 namespace for branching strategies, cascade, council, shadow, snowball. |
|
code
Package code is the Stage-1 namespace for code-aware features (context extraction, lenses, actions, explainer).
|
Package code is the Stage-1 namespace for code-aware features (context extraction, lenses, actions, explainer). |
|
compact
Package compact is the Stage-1 namespace for the engine package's compaction-related types and functions.
|
Package compact is the Stage-1 namespace for the engine package's compaction-related types and functions. |
|
control
Package control is the Stage-1 namespace for engine control-flow safety types — loop detection, stall detection, backtracking.
|
Package control is the Stage-1 namespace for engine control-flow safety types — loop detection, stall detection, backtracking. |
|
cost
Package cost is the Stage-1 namespace for cost-tracking types and functions in package engine.
|
Package cost is the Stage-1 namespace for cost-tracking types and functions in package engine. |
|
ctxmgr
Package ctxmgr is the Stage-1 namespace for context budget, decay, packing, providers, visualisation, and read-only context.
|
Package ctxmgr is the Stage-1 namespace for context budget, decay, packing, providers, visualisation, and read-only context. |
|
diff
Package diff is the Stage-1 namespace for diff sandbox, staging, preview, summariser, test selector, and 3-way merge.
|
Package diff is the Stage-1 namespace for diff sandbox, staging, preview, summariser, test selector, and 3-way merge. |
|
docs
Package docs is the Stage-1 namespace for documentation generation, external docs fetching, and doc updating.
|
Package docs is the Stage-1 namespace for documentation generation, external docs fetching, and doc updating. |
|
errs
Package errs is the Stage-1 namespace for error context enrichment, grouping, learning, patterns, and recovery.
|
Package errs is the Stage-1 namespace for error context enrichment, grouping, learning, patterns, and recovery. |
|
git
Package git is the Stage-1 namespace for git-related types and functions in package engine.
|
Package git is the Stage-1 namespace for git-related types and functions in package engine. |
|
history
Package history is the Stage-1 namespace for command history, conversation summarisation, distillation, head/tail, annotations.
|
Package history is the Stage-1 namespace for command history, conversation summarisation, distillation, head/tail, annotations. |
|
intelligence
Package intelligence is the Stage-1 namespace for intent classification, capabilities, language support, tool selection.
|
Package intelligence is the Stage-1 namespace for intent classification, capabilities, language support, tool selection. |
|
io
Package io is the Stage-1 namespace for clipboard, AI watcher, file watcher, and cron scheduler types.
|
Package io is the Stage-1 namespace for clipboard, AI watcher, file watcher, and cron scheduler types. |
|
lifecycle
Package lifecycle is the Stage-1 namespace for session lifecycle, limits, timeouts, and sleep-time operations.
|
Package lifecycle is the Stage-1 namespace for session lifecycle, limits, timeouts, and sleep-time operations. |
|
memory
Package memory is the Stage-1 namespace for knowledge, experience, and memory consolidation types.
|
Package memory is the Stage-1 namespace for knowledge, experience, and memory consolidation types. |
|
observability
Package observability is the Stage-1 namespace for profiling, debug recording, structured logging, feedback.
|
Package observability is the Stage-1 namespace for profiling, debug recording, structured logging, feedback. |
|
planning
Package planning is the Stage-1 namespace for task planning, decomposition, goals, and suggested tasks.
|
Package planning is the Stage-1 namespace for task planning, decomposition, goals, and suggested tasks. |
|
project
Package project is the Stage-1 namespace for project analysis, snapshots, impact analysis, dep updates, migrations, releases.
|
Package project is the Stage-1 namespace for project analysis, snapshots, impact analysis, dep updates, migrations, releases. |
|
prompt
Package prompt is the Stage-1 namespace for prompt-construction and prompt-optimisation types in package engine.
|
Package prompt is the Stage-1 namespace for prompt-construction and prompt-optimisation types in package engine. |
|
retry
Package retry is the Stage-1 namespace for retry-queue types in package engine.
|
Package retry is the Stage-1 namespace for retry-queue types in package engine. |
|
review
Package review is the Stage-1 namespace for self-review / critique / quality scoring types in package engine.
|
Package review is the Stage-1 namespace for self-review / critique / quality scoring types in package engine. |
|
safety
Package safety is the Stage-1 namespace for hallucination guard, output redaction, permissions, risk assessment.
|
Package safety is the Stage-1 namespace for hallucination guard, output redaction, permissions, risk assessment. |
|
scaffold
Package scaffold is the Stage-1 namespace for scaffolding, recipes, patterns, skills, and few-shot types.
|
Package scaffold is the Stage-1 namespace for scaffolding, recipes, patterns, skills, and few-shot types. |
|
search
Package search is the Stage-1 namespace for URL scraping, issue search, and research agent types.
|
Package search is the Stage-1 namespace for URL scraping, issue search, and research agent types. |
|
session
Package session is the Stage-1 namespace for session-lifecycle types in package engine.
|
Package session is the Stage-1 namespace for session-lifecycle types in package engine. |
|
streaming
Package streaming is the Stage-1 namespace for response caching, formatting, stream optimisation, thinking protocol, and steering.
|
Package streaming is the Stage-1 namespace for response caching, formatting, stream optimisation, thinking protocol, and steering. |
|
token
Package token is the Stage-1 namespace for token-related types and functions in package engine.
|
Package token is the Stage-1 namespace for token-related types and functions in package engine. |
|
validation
Package validation is the Stage-1 namespace for generated-code validation, schema validation, test loops, and lint loops.
|
Package validation is the Stage-1 namespace for generated-code validation, schema validation, test loops, and lint loops. |
|
workflow
Package workflow is the Stage-1 namespace for workflow + workspace + trajectory types in package engine.
|
Package workflow is the Stage-1 namespace for workflow + workspace + trajectory types in package engine. |
|
Package health provides health check and readiness probe support.
|
Package health provides health check and readiness probe support. |
|
Package ide provides IDE integration hints and metadata.
|
Package ide provides IDE integration hints and metadata. |
|
internal
|
|
|
Package localize implements hierarchical fault localization inspired by OpenAutoCoder/Agentless.
|
Package localize implements hierarchical fault localization inspired by OpenAutoCoder/Agentless. |
|
Package logger provides structured logging with levels.
|
Package logger provides structured logging with levels. |
|
Package mention implements @-prefixed file mentions in prompt input, enabling users to reference project files that get auto-included as context.
|
Package mention implements @-prefixed file mentions in prompt input, enabling users to reference project files that get auto-included as context. |
|
Package metrics provides basic metrics collection (counters, timers, gauges).
|
Package metrics provides basic metrics collection (counters, timers, gauges). |
|
Package planner implements structured planning that generates artifacts before coding begins.
|
Package planner implements structured planning that generates artifacts before coding begins. |
|
Package profile provides runtime profiling helpers.
|
Package profile provides runtime profiling helpers. |
|
Package prompt provides the system prompt for hawk.
|
Package prompt provides the system prompt for hawk. |
|
Package ratelimit provides token bucket rate limiting.
|
Package ratelimit provides token bucket rate limiting. |
|
Package recipe also provides declarative provider configuration.
|
Package recipe also provides declarative provider configuration. |
|
Package repomap generates a lightweight code structure map of a repository by scanning files and extracting top-level symbols using regex-based parsers.
|
Package repomap generates a lightweight code structure map of a repository by scanning files and extracting top-level symbols using regex-based parsers. |
|
Package retry provides configurable retry logic with exponential backoff.
|
Package retry provides configurable retry logic with exponential backoff. |
|
Package model provides model routing and health checking.
|
Package model provides model routing and health checking. |
|
Package rules provides import/export of AI coding rules between different tool formats (hawk, Cursor, Claude Code, Copilot, Gemini).
|
Package rules provides import/export of AI coding rules between different tool formats (hawk, Cursor, Claude Code, Copilot, Gemini). |
|
Package sandbox provides sandbox mode for isolated command execution.
|
Package sandbox provides sandbox mode for isolated command execution. |
|
sarif
module
|
|
|
Package sessioncapture provides terminal context capture with delta-based tracking.
|
Package sessioncapture provides terminal context capture with delta-based tracking. |
|
Package shellmode implements the ! prefix for direct shell command execution in the REPL input, bypassing the LLM entirely.
|
Package shellmode implements the ! prefix for direct shell command execution in the REPL input, bypassing the LLM entirely. |
|
Package shutdown provides graceful shutdown handling for applications.
|
Package shutdown provides graceful shutdown handling for applications. |
|
Package staleness detects rules/skills that are no longer actively used or that contradict observed user behavior.
|
Package staleness detects rules/skills that are no longer actively used or that contradict observed user behavior. |
|
Package taste implements a learning system that observes user coding preferences and builds a style profile over time to improve agent output alignment.
|
Package taste implements a learning system that observes user coding preferences and builds a style profile over time to improve agent output alignment. |
|
Package trace provides Langfuse tracing integration for LLM observability.
|
Package trace provides Langfuse tracing integration for LLM observability. |
Click to show internal directories.
Click to hide internal directories.