Skip to content

fix(mip,minimal,minimald): self-identify per binary and correct stale CLI help - #853

Merged
norrietaylor merged 1 commit into
mainfrom
pr/03-mip-identity
Jul 20, 2026
Merged

fix(mip,minimal,minimald): self-identify per binary and correct stale CLI help#853
norrietaylor merged 1 commit into
mainfrom
pr/03-mip-identity

Conversation

@norrietaylor

@norrietaylor norrietaylor commented Jul 20, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Third PR in the oss/integration decomposition — the only behavior-touching code change in the set (WS3). Everything here is user-visible CLI identity/help text.

What

  • Per-binary identity. The mip binary declared clap name = "minimal" with the about-line "The Minimal CLI", so mip --help and its completions mis-identified themselves. Each binary now names itself — min (the session CLI) and mip (the package/build CLI) — each with a distinct about-line.
  • Stale help/example text. minimal <cmd> examples become min / mip across the CLIs; the minimald completions example is corrected; internal (DM2) markers are dropped from user-facing help; the dep flag example is updated (--input_deps_depth → --input-deps-depth).
  • clap propagation fix. GlobalArgs's /// doc comment is demoted to a plain // comment — clap was flattening it into the parent command's long_about, replacing the top-level min --help description.
  • Adds Clean-subcommand help text in mip cache.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated CLI help, usage text, examples, and follow-up instructions to consistently use the min and mip command names.
    • Clarified mesh enrollment, activation, SSH forwarding, login, and shell guidance.
    • Improved cache cleanup documentation, including removal criteria and duration formats.
    • Refined daemon option descriptions and completion command examples.

@coderabbitai

coderabbitai Bot commented Jul 20, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Updated CLI metadata, help text, examples, prompts, and documentation across min, minimald, and mip to use current command names. No runtime behavior or data structures changed.

Changes

CLI help and documentation alignment

Layer / File(s) Summary
min CLI help and prompt updates
crates/minimal/src/{lib.rs,prompt.rs,dirs.rs}, crates/minimal/src/diag/collect.rs		 Updates min command metadata, examples, prompts, mesh documentation, and shared Clap help handling.
minimald help wording
crates/minimald/src/main.rs		 Rewords completions and listen-option documentation without changing behavior.
mip command help and guidance
crates/mip/src/{main.rs,cmd_run.rs,cmd_init.rs,cmd_cache.rs}		 Updates mip metadata, usage labels, examples, initialization guidance, and cache-clean documentation.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Suggested reviewers: twitchyliquid64

Poem

I’m a rabbit with a CLI tune,
Hopping from old names to min by moon.
mip guides sparkle, help blooms bright,
Prompts and commands now fit just right.
No code paths changed beneath the sun—
Just clearer words for everyone!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description covers the main changes, but it does not follow the required template and omits the Summary, Testing, and Checklist sections. Restructure the PR description to use the template headings and add a Summary, Testing evidence, and the Checklist items.
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title is specific, concise, and accurately summarizes the CLI identity and help-text updates in the PR.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch

Comment @coderabbitai help to get the list of available commands.

@norrietaylor @claude
fix(mip,minimal,minimald): self-identify per binary and correct stale…
1136e73 
… CLI help

The `mip` binary declared clap `name = "minimal"` with the about-line "The
Minimal CLI", so `mip --help` and its completions mis-identified themselves.
Name each binary for itself — `min` (the session CLI) and `mip` (the
package/build CLI) — each with a distinct about-line.

Correct stale user-visible text across the CLIs: `minimal <cmd>` examples
become `min`/`mip`, fix the daemon completions example, drop internal `(DM2)`
markers from help, and update the `dep` flag example. Demote GlobalArgs's doc
comment to a plain comment so clap no longer propagates it into the top-level
`min --help` long_about.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@norrietaylor
norrietaylor marked this pull request as ready for review July 20, 2026 22:42
@norrietaylor
norrietaylor enabled auto-merge (squash) July 20, 2026 22:43
@norrietaylor
norrietaylor merged commit dee52ce into main Jul 20, 2026
28 checks passed
@norrietaylor
norrietaylor deleted the pr/03-mip-identity branch July 20, 2026 22:55
This was referenced Jul 25, 2026
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@twitchyliquid64 twitchyliquid64 twitchyliquid64 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@norrietaylor @twitchyliquid64