README
¶
codereview-cli
Open CLI Collective code review CLI.
The review pipeline is still pending. The current binary provides the Cobra root, version command, and command wiring seam that future review commands will attach to.
Current shape
- Go module:
github.com/open-cli-collective/codereview-cli - Intended CLI name:
cr - Branch protection target:
main
Repo policy
Use GitHub branch protection on main with:
- required pull request reviews
- at least one approval
- stale review dismissal
- required status checks for
build,test,lint,pr-title, andidentity-check - no direct pushes
- squash merge only
Development
make tidy
make lint
make test
make build
make snapshot # local goreleaser build (no publish)
The tree currently holds a scaffold cr binary (cmd/cr) with a Cobra root and
version command, plus the CI and release machinery, ahead of the review command
surface.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
cr
command
Command cr is the Open CLI Collective code-review CLI.
|
Command cr is the Open CLI Collective code-review CLI. |
|
internal
|
|
|
agents
Package agents loads trusted review agent definitions.
|
Package agents loads trusted review agent definitions. |
|
cmd/agentscmd
Package agentscmd wires the `cr agents` command surface.
|
Package agentscmd wires the `cr agents` command surface. |
|
cmd/cmderr
Package cmderr maps domain errors onto cr's command exit taxonomy.
|
Package cmderr maps domain errors onto cr's command exit taxonomy. |
|
cmd/configcmd
Package configcmd wires the `cr config` command surface.
|
Package configcmd wires the `cr config` command surface. |
|
cmd/credentialcmd
Package credentialcmd wires credential ingress commands.
|
Package credentialcmd wires credential ingress commands. |
|
cmd/datacmd
Package datacmd wires the `cr data` command surface.
|
Package datacmd wires the `cr data` command surface. |
|
cmd/exitcode
Package exitcode centralizes cr's command-layer process exit taxonomy.
|
Package exitcode centralizes cr's command-layer process exit taxonomy. |
|
cmd/mecmd
Package mecmd wires the `cr me` command surface.
|
Package mecmd wires the `cr me` command surface. |
|
cmd/reviewcmd
Package reviewcmd wires the `cr review` command surface.
|
Package reviewcmd wires the `cr review` command surface. |
|
cmd/root
Package root builds the cr root command and owns root-level command wiring.
|
Package root builds the cr root command and owns root-level command wiring. |
|
cmd/sessionscmd
Package sessionscmd wires the `cr sessions` command surface.
|
Package sessionscmd wires the `cr sessions` command surface. |
|
config
Package config loads and validates cr's non-secret configuration.
|
Package config loads and validates cr's non-secret configuration. |
|
credentials
Package credentials adapts cli-common/credstore to cr's command surface.
|
Package credentials adapts cli-common/credstore to cr's command surface. |
|
datalifecycle
Package datalifecycle manages cr's durable local data retention.
|
Package datalifecycle manages cr's durable local data retention. |
|
dbmig
Package dbmig applies forward-only SQLite schema migrations.
|
Package dbmig applies forward-only SQLite schema migrations. |
|
gate
Package gate decides whether a codereview run should resume, repair, exit, retry posts, abort stale state, or run fresh from summarized state.
|
Package gate decides whether a codereview run should resume, repair, exit, retry posts, abort stale state, or run fresh from summarized state. |
|
gateio
Package gateio maps provider/ledger state into the pure gate kernel.
|
Package gateio maps provider/ledger state into the pure gate kernel. |
|
gitprovider
Package gitprovider defines the provider-neutral git host seam.
|
Package gitprovider defines the provider-neutral git host seam. |
|
gitprovider/github
Package github adapts GitHub REST and GraphQL APIs to gitprovider read models.
|
Package github adapts GitHub REST and GraphQL APIs to gitprovider read models. |
|
identity
Package identity resolves live git-host identities and refreshes config caches.
|
Package identity resolves live git-host identities and refreshes config caches. |
|
ledger
Package ledger stores cr review runs in SQLite.
|
Package ledger stores cr review runs in SQLite. |
|
llm
Package llm defines provider-neutral LLM adapter contracts and structured output validation for review planning.
|
Package llm defines provider-neutral LLM adapter contracts and structured output validation for review planning. |
|
marker
Package marker renders and parses codereview PR comment markers.
|
Package marker renders and parses codereview PR comment markers. |
|
outbox
Package outbox posts planned review actions through the host-agnostic provider seam.
|
Package outbox posts planned review actions through the host-agnostic provider seam. |
|
pipeline
Package pipeline orchestrates review pipeline phases without owning command IO.
|
Package pipeline orchestrates review pipeline phases without owning command IO. |
|
prref
Package prref parses and normalizes pull-request references.
|
Package prref parses and normalizes pull-request references. |
|
review
Package review defines provider-neutral review-domain values.
|
Package review defines provider-neutral review-domain values. |
|
reviewplan
Package reviewplan builds the pure PR review action plan.
|
Package reviewplan builds the pure PR review action plan. |
|
reviewrun
Package reviewrun wires live review orchestration around gate, pipeline, and outbox.
|
Package reviewrun wires live review orchestration around gate, pipeline, and outbox. |
|
runlock
Package runlock provides fail-fast advisory file locks for live review runs.
|
Package runlock provides fail-fast advisory file locks for live review runs. |
|
sessionreuse
Package sessionreuse validates named LLM session reuse scope.
|
Package sessionreuse validates named LLM session reuse scope. |
|
statepaths
Package statepaths composes cr-specific data and cache paths.
|
Package statepaths composes cr-specific data and cache paths. |
|
version
Package version holds the build-stamped version metadata for the cr binary.
|
Package version holds the build-stamped version metadata for the cr binary. |
|
view
Package view renders user-facing command output from typed values.
|
Package view renders user-facing command output from typed values. |
Click to show internal directories.
Click to hide internal directories.