Synced from Hive. This page is pulled from hivecommons/hive@v5 during the docs build. Edit the canonical source in the Hive repository.

Integration guide

Audience: platform teams and tool authors who want Hive to read a non-GitHub backlog, lend external execution capacity, or connect planning/specification tools without over-claiming what v5 can do today.

The canonical Hive documentation source for the published Hive docs is this repository’s src/docs/ tree. The separate hivecommons/docs site repository is the Next.js/Nextra shell for docs.hivecommons.dev; its README says the site syncs Hive content from hivecommons/hive src/docs/ on branch v5. Put Hive guide changes here first, then let that mirror pick them up.

Extension surfaces in v5

SurfaceWhat you can do todayStart here
Work sourcesAdd or configure an adapter that turns source-native items into worksource.Issue values. The primary adapters linked today are GitHub Issues, GitHub Projects, Linear, and Jira; run stages and Wavefront are additive sources.Work source providers
ClankeR + Flue-style external executionUse the contributor relay as the transport and the pkg/extwork contract as the engine-neutral admission/observation seam. Flue is the reference HTTP adapter.ClankeR and Flue-style external execution
SpektacularLet Hive poll a Spektacular-compatible CLI for spec/plan status and import final plan tasks into Hive’s run flow.Spektacular and Project Inception

Related surfaces that are not redefined here: agent configuration, CLI/backend setup, MCP write policy, hub API, contributor relay, work sources, long-running runs, and Spektacular runner.

Terminology

Use source-neutral words in generic integration docs: work source, project, item, and change request. Keep product names when talking about a specific adapter, such as GitHub Projects or Jira. The glossary and guard-test intent live in Work-source terminology.

Gaps tracked from this guide

  • Work source adapters are compile-time Go integrations, not external plugins: #10174.
  • Project Inception wires a Spektacular-compatible CLI boundary; there is no generic named planning-engine registry: #10175.