Skip to content

docs: make the README a full CLI-contract reference#1676

Merged
mergify[bot] merged 1 commit into
mainfrom
devs/JulianMaurin/feat/rust-cli-excellence/make-readme-full-cli-contract-ref--4677f612
Jun 25, 2026
Merged

docs: make the README a full CLI-contract reference#1676
mergify[bot] merged 1 commit into
mainfrom
devs/JulianMaurin/feat/rust-cli-excellence/make-readme-full-cli-contract-ref--4677f612

Conversation

@JulianMaurin

@JulianMaurin JulianMaurin commented Jun 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Expand README.md from a flat command list into a group-altitude CLI
reference: command groups, the token/repository/api-url resolution order,
global options, environment variables, exit codes, and shell completions,
plus badges and a quick-start. Per-subcommand detail stays in --help and
docs.mergify.com.

Rewrite the AGENTS.md README rule to match: keep the group-altitude contract
current — command groups, global flags, env fallbacks, exit codes — and do
not re-add an exhaustive subcommand list. The cli_schema_golden test guards
the schema snapshot, not the README prose.

Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com

@JulianMaurin JulianMaurin mentioned this pull request Jun 23, 2026
Merged
@JulianMaurin

JulianMaurin commented Jun 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

This pull request is part of a Mergify stack:

# Pull Request Link
1 docs: make the README a full CLI-contract reference #1676 👈
2 fix(queue): treat a not-queued PR as a normal state, not an API error #1678
3 fix(config): surface an invalid simulate config as a config error #1679
4 fix(ci): return a runtime error when scopes --write fails #1680
5 fix(stack): exit not-found when checkout finds no stack #1681
6 feat(cli): support the git-style help subcommand #1682
7 docs(cli): correct stack reorder and scopes-send help text #1683

@mergify mergify Bot had a problem deploying to Mergify Merge Protections June 23, 2026 13:08 Failure
@JulianMaurin JulianMaurin mentioned this pull request Jun 23, 2026
Merged
@mergify

mergify Bot commented Jun 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Merge Protections

🟢 All 6 merge protections satisfied — ready to merge.

Show 6 satisfied protections

🟢 🤖 Continuous Integration

  • all of:
    • check-success=ci-gate

🟢 👀 Review Requirements

  • any of:
    • #approved-reviews-by>=2
    • author = dependabot[bot]
    • author = mergify-ci-bot
    • author = renovate[bot]

🟢 Enforce conventional commit

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|ui)(?:\(.+\))?:

🟢 🔎 Reviews

  • #changes-requested-reviews-by = 0
  • #review-requested = 0
  • #review-threads-unresolved = 0

🟢 📕 PR description

  • body ~= (?ms:.{48,})

🟢 🚦 Auto-queue

When all merge protections are satisfied, this pull request will be queued automatically.

@mergify mergify Bot requested a review from a team June 23, 2026 13:16
@JulianMaurin JulianMaurin force-pushed the devs/JulianMaurin/feat/rust-cli-excellence/make-readme-full-cli-contract-ref--4677f612 branch from e7b5606 to f77d690 Compare June 23, 2026 13:19
@JulianMaurin

JulianMaurin commented Jun 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Revision history

# Type Changes Reason Date
1 initial e7b5606 2026-06-23 13:19 UTC
2 content e7b5606 → f77d690 (raw) trim README command list to top-level groups; per-subcommand detail belongs in --help/docs, not the README 2026-06-23 13:19 UTC
3 content f77d690 → 16f2d20 (raw) quick start: add the one-time 'stack setup' step (review) 2026-06-23 13:57 UTC
4 rebase 16f2d20 → 4e28508 (rebase only) 2026-06-25 07:49 UTC
5 rebase 4e28508 → e9c1676 (rebase only) reword: drop inaccurate 'subcommand tree'/'subcommands' claims — the README and AGENTS.md rule deliberately keep per-subcommand detail in --help and docs.mergify.com 2026-06-25 07:56 UTC

@mergify mergify Bot had a problem deploying to Mergify Merge Protections June 23, 2026 13:19 Failure
@JulianMaurin JulianMaurin marked this pull request as ready for review June 23, 2026 13:20
kozlek
kozlek previously approved these changes Jun 23, 2026
View reviewed changes
Comment thread README.md
@mergify mergify Bot requested a review from a team June 23, 2026 13:44
@JulianMaurin JulianMaurin force-pushed the devs/JulianMaurin/feat/rust-cli-excellence/make-readme-full-cli-contract-ref--4677f612 branch from f77d690 to 16f2d20 Compare June 23, 2026 13:57
@mergify mergify Bot dismissed kozlek’s stale review June 23, 2026 13:57

Pull request has been modified.

@mergify mergify Bot had a problem deploying to Mergify Merge Protections June 23, 2026 13:57 Failure
This was referenced Jun 23, 2026
Merged
Merged
Merged
Merged
Merged
Merged
jd
jd previously approved these changes Jun 23, 2026
View reviewed changes
@mergify mergify Bot requested a review from a team June 23, 2026 18:53
Base automatically changed from devs/JulianMaurin/feat/rust-cli-excellence/print-enable-shell-completions--9231ed40 to main June 25, 2026 07:46
@mergify mergify Bot dismissed jd’s stale review June 25, 2026 07:46

The base branch was changed.

@JulianMaurin JulianMaurin force-pushed the devs/JulianMaurin/feat/rust-cli-excellence/make-readme-full-cli-contract-ref--4677f612 branch from 16f2d20 to 4e28508 Compare June 25, 2026 07:49
@mergify mergify Bot deployed to Mergify Merge Protections June 25, 2026 07:49 Active
jd
jd previously approved these changes Jun 25, 2026
View reviewed changes
@JulianMaurin @claude
docs: make the README a full CLI-contract reference
e9c1676 
Expand README.md from a flat command list into a group-altitude CLI
reference: command groups, the token/repository/api-url resolution order,
global options, environment variables, exit codes, and shell completions,
plus badges and a quick-start. Per-subcommand detail stays in `--help` and
docs.mergify.com.

Rewrite the AGENTS.md README rule to match: keep the group-altitude contract
current — command groups, global flags, env fallbacks, exit codes — and do
not re-add an exhaustive subcommand list. The cli_schema_golden test guards
the schema snapshot, not the README prose.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Change-Id: I4677f612bd5c0043c213414f009575974b1a0f96
@mergify mergify Bot requested a review from a team June 25, 2026 07:55
kozlek
kozlek previously approved these changes Jun 25, 2026
View reviewed changes
@JulianMaurin JulianMaurin force-pushed the devs/JulianMaurin/feat/rust-cli-excellence/make-readme-full-cli-contract-ref--4677f612 branch from 4e28508 to e9c1676 Compare June 25, 2026 07:56
@mergify mergify Bot dismissed stale reviews from kozlek and jd June 25, 2026 07:56

Pull request has been modified.

@mergify mergify Bot deployed to Mergify Merge Protections June 25, 2026 07:56 Active
@mergify mergify Bot requested a review from a team June 25, 2026 08:03
@mergify mergify Bot requested a review from a team June 25, 2026 08:27
@mergify

mergify Bot commented Jun 25, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Queued — the merge queue status continues in this comment ↓.

@mergify

mergify Bot commented Jun 25, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Merge Queue Status

  • ✅ Entered queue — 2026-06-25 08:37 UTC · Rule: default · triggered by merge protections
  • ✅ Checks skipped · PR is already up-to-date
  • ✅ Merged — 2026-06-25 08:38 UTC · at e9c1676aad9b57722de41052af91df3fab3e8399 · squash

This pull request spent 23 seconds in the queue, including 4 seconds running CI.

Required conditions to merge

@mergify mergify Bot merged commit 85009ae into main Jun 25, 2026
22 of 42 checks passed
@mergify mergify Bot deleted the devs/JulianMaurin/feat/rust-cli-excellence/make-readme-full-cli-contract-ref--4677f612 branch June 25, 2026 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kozlek kozlek kozlek approved these changes
@remyduthu remyduthu remyduthu approved these changes
@jd jd jd left review comments

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@JulianMaurin @jd @kozlek @remyduthu