[PR #316] [MERGED] cli: add examples to build help #342

New issue

Closed

opened 2026-10-29 14:22:24 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-29 14:22:24 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/kvcache-ai/AgentENV/pull/316
Author: @tcy24
Created: 9/23/2026
Status: ✅ Merged
Merged: 9/24/2026
Merged by: @yingdi-shan

Base: main ← Head: docs/build-help-examples

📝 Commits (1)

d7cd132 cli: add examples to build help

📊 Changes

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

View changed files

📝 crates/aenv/src/commands/build.rs (+6 -0)

📄 Description

What

Add usage examples to aenv build --help, including an example showing how to use -f to specify a custom Dockerfile.

Why

Make it easier for users to understand how to use aenv build directly from the CLI help.

N/A

Scope and non-goals

This PR only updates the CLI help text for aenv build. No build behavior or implementation logic is changed.

Design and behavior changes

No behavior changes. The after_help section adds three usage examples to aenv build --help.

Compatibility and operations

Public API or generated protocol:N/A
Configuration or defaults:N/A
Snapshot manifest, artifact layout, or storage format:N/A
Upgrade and rollback:N/A
Host requirements, permissions, ports, or dependencies:N/A

Validation

make fmt
make clippy
make test-unit
Relevant Rust integration tests
make -C services test (required when services/ changes)
Generated clients/server regenerated with the documented make target
Documentation updated
Benchmarks or performance comparison completed

Commands and results:

cargo check -p aenv
cargo run -p aenv -- build --help
git diff --check

All commands completed successfully. The generated help output includes the new aenv build examples, including usage of -f.

Skipped checks and reasons:

make fmt, make clippy, and make test-unit were not run because this PR only changes CLI help text.

Risks and reviewer notes

Low risk. This change only affects the displayed CLI help text and does not modify build behavior.
The main change is in crates/aenv/src/commands/build.rs.

Checklist

[×] The PR contains one coherent change and no unrelated formatting or refactoring.
New behavior is covered by tests, or I explained why testing is impractical.
[×] Logs and examples contain no credentials, tokens, or private registry information.
[×] I did not manually edit generated code without updating its source and regenerating it.

_{🔄 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/316 **Author:** [@tcy24](https://github.com/tcy24) **Created:** 9/23/2026 **Status:** ✅ Merged **Merged:** 9/24/2026 **Merged by:** [@yingdi-shan](https://github.com/yingdi-shan) **Base:** `main` ← **Head:** `docs/build-help-examples` --- ### 📝 Commits (1) - [`d7cd132`](https://github.com/kvcache-ai/AgentENV/commit/d7cd1326ec27c367777aed426ea3b787158c4a9c) cli: add examples to build help ### 📊 Changes **1 file changed** (+6 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `crates/aenv/src/commands/build.rs` (+6 -0) </details> ### 📄 Description ## What Add usage examples to aenv build --help, including an example showing how to use -f to specify a custom Dockerfile. ## Why Make it easier for users to understand how to use aenv build directly from the CLI help. ## Related issue N/A ## Scope and non-goals This PR only updates the CLI help text for aenv build. No build behavior or implementation logic is changed. ## Design and behavior changes No behavior changes. The after_help section adds three usage examples to aenv build --help. ## Compatibility and operations - Public API or generated protocol:N/A - Configuration or defaults:N/A - Snapshot manifest, artifact layout, or storage format:N/A - Upgrade and rollback:N/A - Host requirements, permissions, ports, or dependencies:N/A ## Validation - [ ] `make fmt` - [ ] `make clippy` - [ ] `make test-unit` - [ ] Relevant Rust integration tests - [ ] `make -C services test` (required when `services/` changes) - [ ] Generated clients/server regenerated with the documented `make` target - [ ] Documentation updated - [ ] Benchmarks or performance comparison completed Commands and results: ```text cargo check -p aenv cargo run -p aenv -- build --help git diff --check All commands completed successfully. The generated help output includes the new aenv build examples, including usage of -f. ``` Skipped checks and reasons: make fmt, make clippy, and make test-unit were not run because this PR only changes CLI help text. ## Risks and reviewer notes Low risk. This change only affects the displayed CLI help text and does not modify build behavior. The main change is in crates/aenv/src/commands/build.rs. ## Checklist - [×] The PR contains one coherent change and no unrelated formatting or refactoring. - [ ] New behavior is covered by tests, or I explained why testing is impractical. - [×] Logs and examples contain no credentials, tokens, or private registry information. - [×] I did not manually edit generated code without updating its source and regenerating it. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-29 14:22:24 +00:00