fix: print help to stdout and support -h alias - #16
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the bifrost CLI help/usage behavior to better align with common CLI conventions by adding a -h alias, routing help text to stdout, and routing usage/errors to stderr, with added tests and README updates.
Changes:
- Add
-has an alias for--helpand update README option documentation. - Route help output to stdout, while keeping usage/errors on stderr.
- Add CLI tests that assert correct streams and exit codes for help/no-arg scenarios.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
README.md |
Documents -h alongside --help in the options table. |
internal/bifrost/cli.go |
Adds -h alias and refactors help/usage printing to support stdout/stderr routing and “help after command” handling. |
internal/bifrost/cli_test.go |
Adds tests and a helper to capture both stdout and stderr for help/no-arg behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
alexanderbsingh
marked this pull request as ready for review
July 23, 2026 09:30
konrader
approved these changes
Aug 6, 2026
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.
-has an alias for--help.