Uh oh!
There was an error while loading. Please reload this page.
docs: CLI navigation map (single source of truth) - #243
Merged
Conversation
aptracebloc
previously approved these changes
Jul 13, 2026
Four Mermaid flowcharts (top-level, the two gate chains, data ingest, resources) + exit-code legend + cross-links + known gaps. Diffable, renders on GitHub, kept current via PRs. Flags: two independent gate chains; stateless home today (status redesign proposed); delete exits 0 on partial offboard; resources unshipped. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
#237 put `resources show` on develop, so un-dash SHOW (keep `set`/#241 dashed), bump the basis commit to develop @27c5392, and reconcile the §4 heading + known-gaps note. The exit-6/--overwrite flow already matches current develop (data.go:236), so it's left as-is. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
aptraceblocforce-pushed
the
docs/cli-navigation-map
branch
from
July 13, 2026 09:38
267e792 to
2bea591Compareaptracebloc
approved these changes
Jul 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
docs/cli-navigation.md— the single source of truth for how a user moves through the CLI. Four Mermaid flowcharts (top-level map · the two gate chains ·data ingest·resources) + an exit-code legend + cross-links + a "known gaps" section. Renders natively in the Files tab; it's text, so it's diffable and stays live via PRs (this PR is where we discuss flow changes).Why
As the CLI grows we need one canonical, viewable, discussable picture of every path and where a user can end up — not a drawing in a tool nobody can diff.
Notable structural facts it surfaced (worth the team's eyes)
client createanddeletecross both.home-screen-spec.md) is proposed, drawn dashed.delete(offboard) exits 0 even on a partial/degraded teardown — no non-zero "incomplete offboard" code; a real gap for automation.data ingestexit codes are non-monotonic in execution order (staging exit-7 fires before the token exit-5).resourcesis drawn dashed — feature branch (feat(resources):tracebloc resources— show this machine's allowance (SHOW; set deferred) (#143) #237/feat(resources):tracebloc resources set— guided compute budget (P2, wizard + GPU) (#143) #241), not yet ondevelop.Docs-only; no code change.
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only change with no runtime or code behavior impact.
Overview
Introduces
docs/cli-navigation.mdas the version-controlled, PR-reviewable map of how users move throughtracebloc/tb: four Mermaid flowcharts plus exit-code table, recovery cross-links, and a known gaps section.The top-level map groups account vs secure-environment commands, aliases, and hidden/back-compat routes. Chain A vs Chain B documents that account commands require a user token while data/environment commands use kubeconfig + in-cluster token without sign-in. Dedicated diagrams cover
data ingest(wizard vs flags, local checks, staging, outcomes) andresources(showsolid ondevelop;setand the status-aware home screen drawn dashed as not shipped / proposed).The doc pins basis to
develop@27c5392and calls out review topics (e.g. offboard always exit 0, non-monotonic ingest exit codes).Reviewed by Cursor Bugbot for commit 2bea591. Bugbot is set up for automated code reviews on this repo. Configure here.