Skip to content
OpenCodeHub

codehub-onboarding

Produces a single ONBOARDING.md. The wedge is the ranked reading order drawn from graph centrality — a generic README scaffold cannot produce this.

Frontmatter

Section titled “Frontmatter”
name: codehub-onboarding
argument-hint: "[output-path] [--committed]"
color: green
model: sonnet

Preconditions

Section titled “Preconditions”
  • mcp__opencodehub__list_repos must return the target.
  • codehub status must be fresh.

Both refuse loudly with a one-line remediation hint per spec 001 AC-3-1.

Process

Section titled “Process”
  1. mcp__opencodehub__project_profile — languages, stacks, entry points.
  2. mcp__opencodehub__route_map / mcp__opencodehub__tool_map — HTTP / MCP surface.
  3. mcp__opencodehub__sql for top-centrality nodes: 
    SELECT name, file_path, in_degree + out_degree AS centrality
    FROM nodes
    WHERE kind IN ('File','Module','Class')
    ORDER BY centrality DESC
    LIMIT 15
  4. mcp__opencodehub__context on the top 8 for one-line summaries.
  5. mcp__opencodehub__owners on top 3 folders → “ask these humans” table.
  6. Dispatch one specialty doc-onboarding subagent.
  7. Assemble ONBOARDING.md and write to the resolved output path.

Output shape

Section titled “Output shape”
# <repo> · Onboarding


## TL;DR
2 sentences — what this repo does + the mental model to hold.


## Stack
| Layer | Tech | Source |


## Read these 10 files first (in order)
1. `packages/cli/src/bin.ts` — CLI entry point. (45 LOC)
2. `packages/mcp/src/server.ts` — MCP bootstrap. (320 LOC)
... (ranked by centrality)


## Walk one process end-to-end
(the highest-step-count process, traced step by step)


## Ask these humans
| Area | Owner | Share |


## Next steps
- Concrete first actions.

Arguments

Section titled “Arguments”
FlagMeaning
[output-path]Where to write. Default: .codehub/ONBOARDING.md (gitignored). With --committed: docs/ONBOARDING.md.
--committedOpt in to a committed path.
Section titled “Related”