Skip to content

docs(cli): refresh stale root --help string#21

Merged
aptracebloc merged 1 commit into
developfrom
fix/19-root-help-stale-string
Jun 3, 2026
Merged

docs(cli): refresh stale root --help string#21
aptracebloc merged 1 commit into
developfrom
fix/19-root-help-stale-string

Conversation

@saadqbal
Copy link
Copy Markdown
Collaborator

@saadqbal saadqbal commented Jun 3, 2026

Summary

Closes #19.

The root command's Long help (shown on tracebloc --help) still claimed the binary "implements only version and completion" and pointed at the roadmap for "subsequent phases" — stale since v0.1 shipped dataset/ingest/cluster. PR #18 refreshed the README and the three other user-facing --help strings (cluster info, dataset, dataset push) but missed this one. Now describes the shipped command set.

Docs/strings only — no behavior change.

Diff

-Today this binary implements only `version` and `completion` — see .../147 ... Subsequent phases land subcommands incrementally.
+This binary implements the full v0.1 ingestion path: `dataset push` (the dominant workflow above), `ingest validate` for a local
+schema check, `cluster info` for discovery diagnostics, plus `version` and `completion`. See .../147 for the v0.1 roadmap and what's planned next.

Verification

go build, go vet ./..., go test ./... (all 5 pkgs), and gofmt -s -l all clean. No test pinned the old string. Rendered tracebloc --help confirmed to list the shipped commands.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only change to a help string; no runtime or CLI behavior is modified.

Overview
Updates the root command Long text shown on tracebloc --help so it no longer says the binary only ships version and completion.

It now documents the v0.1 surface: dataset push, ingest validate, cluster info, plus version and completion, with the same roadmap link reframed as what’s planned next rather than “subsequent phases.”

Reviewed by Cursor Bugbot for commit 30a0404. Bugbot is set up for automated code reviews on this repo. Configure here.

The root command's Long help still claimed the binary "implements only
version and completion" and pointed at the roadmap for future phases —
stale since v0.1 shipped the dataset/ingest/cluster commands. PR #18
refreshed the README and the three other user-facing --help strings but
missed this one (it scoped to cluster info / dataset / dataset push).
Describe the shipped command set instead.

Docs/strings only; no behavior change.

Closes #19

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@LukasWodka
Copy link
Copy Markdown
Contributor

👋 Heads-up — Code review queue is at 12 / 8

Above the WIP limit. The team convention is to review existing PRs before opening new work.

Open PRs currently in Code review (oldest first):

Pull from review before opening new work. (This is a nudge from the kanban WIP check, not a block.)

@saadqbal saadqbal self-assigned this Jun 3, 2026
@aptracebloc aptracebloc merged commit d0d8af3 into develop Jun 3, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants