[PR #231] [MERGED] docs(cli): restore shell completion section #272

New issue

Closed

opened 2026-10-29 14:21:41 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-29 14:21:41 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/kvcache-ai/AgentENV/pull/231
Author: @NickNYU
Created: 8/30/2026
Status: ✅ Merged
Merged: 8/31/2026
Merged by: @yingdi-shan

Base: main ← Head: docs/restore-shell-completion

📝 Commits (1)

86f6b8e docs(cli): restore shell completion section

📊 Changes

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

View changed files

📝 docs/src/getting-started/aenv-cli.md (+96 -0)

📄 Description

Closes part of #37.

Restores the shell completion documentation removed by c890d29, updated for current behavior:

Callback semantics: aenv completion <shell> now emits a registration script that calls back into the aenv binary (COMPLETE=<shell> aenv ..., per #163), so completion logic follows the installed binary across upgrades; the script resolves aenv via PATH.
Dynamic completion: documents which commands complete live sandbox IDs and how candidates are filtered by command-applicable state (running / paused / both).
Failure behavior: short timeouts (500 ms connect, 1 s request), silent empty candidates when credentials/server/network are unavailable, static completion unaffected.

Verified locally against a build of current main: script contents for Bash/Zsh/Fish, static completion (commands, enums), and silent fallback with no server.

The remaining scope of #37 (template/snapshot name completion, start --cold exception, installer integration) is intentionally not covered here.

_{🔄 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/kvcache-ai/AgentENV/pull/231 **Author:** [@NickNYU](https://github.com/NickNYU) **Created:** 8/30/2026 **Status:** ✅ Merged **Merged:** 8/31/2026 **Merged by:** [@yingdi-shan](https://github.com/yingdi-shan) **Base:** `main` ← **Head:** `docs/restore-shell-completion` --- ### 📝 Commits (1) - [`86f6b8e`](https://github.com/kvcache-ai/AgentENV/commit/86f6b8e5b7f34539c209eace6cd2bec09427957a) docs(cli): restore shell completion section ### 📊 Changes **1 file changed** (+96 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `docs/src/getting-started/aenv-cli.md` (+96 -0) </details> ### 📄 Description Closes part of #37. Restores the shell completion documentation removed by c890d29, updated for current behavior: - **Callback semantics**: `aenv completion <shell>` now emits a registration script that calls back into the `aenv` binary (`COMPLETE=<shell> aenv ...`, per #163), so completion logic follows the installed binary across upgrades; the script resolves `aenv` via PATH. - **Dynamic completion**: documents which commands complete live sandbox IDs and how candidates are filtered by command-applicable state (running / paused / both). - **Failure behavior**: short timeouts (500 ms connect, 1 s request), silent empty candidates when credentials/server/network are unavailable, static completion unaffected. Verified locally against a build of current main: script contents for Bash/Zsh/Fish, static completion (commands, enums), and silent fallback with no server. The remaining scope of #37 (template/snapshot name completion, `start --cold` exception, installer integration) is intentionally not covered here. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-29 14:21:41 +00:00