hyperhive/hive-forge/README.md

33 lines
1.4 KiB
Markdown

# hive-forge
Typed CLI wrapper around the in-cluster Forgejo's REST API — issues,
PRs, comments, labels, reviews, CI status, attachments, triage.
Replaces the old bash-script wrapper so agents and operators get
consistent error handling, exit codes, and JSON shapes. This is the
**only supported path** to the forge from inside an agent container;
never `curl` it directly.
Reads credentials from the environment (`HIVE_FORGE_URL`,
`HYPERHIVE_STATE_DIR`); `-f/--forge <label>` retargets a
dashboard-provisioned external forge account instead. The active repo
resolves `-r/--repo` > the `origin` remote of the cwd's git checkout >
`HIVE_FORGE_REPO` (last-resort override, unset by default) > a hard
error — see `client::Client::from_env`.
## When to use it
Reach for this crate when adding or changing a forge verb — it's the
single place issue/PR/comment/CI logic lives for every agent and
`hivectl`. Adding a *tool* an agent's claude session calls is
`hive-agent-mcp` wrapping a shellout to this binary, not new logic
here.
## Shape
- **`verbs/`** — one module per subcommand (clap `Args` + `run`).
- **`client.rs`** — the Forgejo client wrapper + token loading.
- **`notify.rs`** — the read-before-comment guard, backed by forge's
own notification read-state (no local mirror to drift).
- **`body.rs`** — shared `--body`/`--body-file`/stdin resolution.
Full verb reference: `docs/tools/forge.md`.