Skip to content

DEVELOPER-PATH.md

Latest commit

 

History

History
61 lines (45 loc) · 2.32 KB

DEVELOPER-PATH.md

File metadata and controls

61 lines (45 loc) · 2.32 KB

Developer path — product direction

hawk is built for developers on their own machines — not teams or enterprises (yet).

Who this is for

In scope (now) Out of scope (later)
One developer on macOS or Linux Org-wide admin, SSO, RBAC
Local config at ~/.hawk/ Shared team config servers
API keys in OS keychain Vault, proxy gateways, seat licensing
Local yaad memory (~/.yaad/data/) Team memory sync, cloud graph
Docker/bash isolation on your laptop Fleet sandbox orchestration
hawk path / /config first-run IT-managed deployment packs

Design principles

  1. Zero trust in env files — paste keys in /config; never document export ANTHROPIC_API_KEY as the happy path.
  2. Graceful optional layers — yaad, Docker, MCP are enhancements; core chat works without them.
  3. Honest diagnostics — hawk path tells you exactly what is missing (key, model, Docker, yaad).
  4. Local-first privacy — code stays on your machine except to the LLM provider you choose.
  5. No co-author theater — commits list the human author only (see CONTRIBUTING).

The path

Install hawk
    → hawk (TUI opens /config on first run)
    → Paste API key → OS keychain
    → Pick model from eyrie catalog
    → hawk path  (READY)
    → Chat with tools (Docker bash when available)
    → yaad remembers conventions across sessions (optional)

Verify

hawk path              # readiness report
hawk preflight         # eyrie chat readiness
hawk credentials status
make path              # same checks as CI (verify-developer-path.sh)
./scripts/verify-developer-path.sh

Security model

See SECURITY-DEVELOPER.md for keychain-only credentials, Read-tool path blocks, and container isolation.

Architecture reference

Optional (not required on the path)

  • hawk mission — parallel git worktrees
  • Daemon mode — HTTP API for integrations
  • Multi-agent personas — /agents

When adding features, ask: does this help one developer on their laptop? If not, defer or gate behind explicit opt-in.