[PR #6250] [MERGED] docs(cli): document opt-in Bash completion setup #7227

New issue

Closed

opened 2026-11-01 21:46:19 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-11-01 21:46:19 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/6250
Author: @ShuaixinHuang
Created: 10/22/2026
Status: ✅ Merged
Merged: 10/23/2026
Merged by: @baron

Base: main ← Head: codex/docs-bash-completion-resubmit

📝 Commits (1)

daae263 docs(cli): document opt-in Bash completion setup

📊 Changes

1 file changed (+23 additions, -0 deletions)

View changed files

📝 docs/cli.md (+23 -0)

📄 Description

Summary

Replacement for #5533, closed at the author's request to resubmit. Preserve its final documentation change, including the maintainer's login-shell correction.

The CLI guide lacks setup/removal instructions for existing optional shell completion. Add the Bash hook, current-shell removal, non-login and login startup-file guidance, and the current macOS Bash 3.2 nosort limitation. Related #5481 (documentation portion only) and #5527.

Scope

One file, 23 added lines. Same final patch as #5533, reapplied to upstream bd5d189a. No runtime or dependency changes, new capability, or target interaction. Earlier review remains available in #5533.

Documentation or usability only; no target interaction.

Validation performed

Head daae2633, Windows x64, pinned Node 24.18.0:

npm run docs:check: all six tasks and five README consistency tests passed.
Oxfmt and git diff --check passed.
Actual compiled CLI: completions --help and completions bash both exited 0.
Commit formatting and push-hook typecheck/lint passed.
#5533 previously verified registration, a prefix callback and removal under Git Bash 5.3.15; those interactive checks were not rerun for this replacement.
No shell startup file was edited, and no login-shell integration or macOS Bash 3.2 run was performed. Current-shell command generation does not establish startup-file integration.
Online CI for this new head is pending; #5533's green results do not qualify this new revision.

The existing human initial-readiness declaration below is preserved for the same final documentation patch; resubmission adds no new implementation.

Author readiness

Human owner: @ShuaixinHuang

I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
I declare this PR ready for initial maintainer review.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/6250 **Author:** [@ShuaixinHuang](https://github.com/ShuaixinHuang) **Created:** 10/22/2026 **Status:** ✅ Merged **Merged:** 10/23/2026 **Merged by:** [@baron](https://github.com/baron) **Base:** `main` ← **Head:** `codex/docs-bash-completion-resubmit` --- ### 📝 Commits (1) - [`daae263`](https://github.com/morluto/rea/commit/daae2633f7d6e7ad67302919a71e99b27bcc5685) docs(cli): document opt-in Bash completion setup ### 📊 Changes **1 file changed** (+23 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `docs/cli.md` (+23 -0) </details> ### 📄 Description ## Summary Replacement for #5533, closed at the author's request to resubmit. Preserve its final documentation change, including the maintainer's login-shell correction. The CLI guide lacks setup/removal instructions for existing optional shell completion. Add the Bash hook, current-shell removal, non-login and login startup-file guidance, and the current macOS Bash 3.2 `nosort` limitation. Related #5481 (documentation portion only) and #5527. ## Scope One file, 23 added lines. Same final patch as #5533, reapplied to upstream `bd5d189a`. No runtime or dependency changes, new capability, or target interaction. Earlier review remains available in #5533. - [x] Documentation or usability only; no target interaction. ## Validation performed Head `daae2633`, Windows x64, pinned Node 24.18.0: - `npm run docs:check`: all six tasks and five README consistency tests passed. - Oxfmt and `git diff --check` passed. - Actual compiled CLI: `completions --help` and `completions bash` both exited 0. - Commit formatting and push-hook typecheck/lint passed. - #5533 previously verified registration, a prefix callback and removal under Git Bash 5.3.15; those interactive checks were not rerun for this replacement. - No shell startup file was edited, and no login-shell integration or macOS Bash 3.2 run was performed. Current-shell command generation does not establish startup-file integration. - Online CI for this new head is pending; #5533's green results do not qualify this new revision. The existing human initial-readiness declaration below is preserved for the same final documentation patch; resubmission adds no new implementation. ## Author readiness Human owner: @ShuaixinHuang - [x] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [x] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [x] I declare this PR ready for initial maintainer review. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-11-01 21:46:19 +00:00