docs(cli): add register help examples#1237
Draft
corylanou wants to merge 1 commit intofeat/1232-required-flag-try-hintsfrom
Draft
docs(cli): add register help examples#1237corylanou wants to merge 1 commit intofeat/1232-required-flag-try-hintsfrom
corylanou wants to merge 1 commit intofeat/1232-required-flag-try-hintsfrom
Conversation
PR Build Metrics✅ All clear — no issues detected
Binary Size
Dependency ChangesNo dependency changes. govulncheck OutputBuild Info
🤖 Updated on each push. |
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This stacked draft PR adds an
Examples:section tolitestream register -helpand adds a regression test that locks those examples into the usage output.This PR is intentionally scoped to the
registercheckbox only.Motivation and Context
Issue #1232 tracks agent-friendly CLI improvements, including runnable help examples for command discovery.
Related to #1232
Base branch: #1236 (
feat/1232-required-flag-try-hints)How Has This Been Tested?
go test -run 'TestRegisterCommand_Run|TestRegisterCommand_Usage' ./cmd/litestreamgo test ./cmd/litestreamgo test ./...pre-commit run --all-filesTypes of changes
Checklist
go fmt,go vet)go test ./...)