-
Notifications
You must be signed in to change notification settings - Fork 123
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: improve examples on several command line arguments. #310
Open
milanglacier
wants to merge
1
commit into
charmbracelet:main
Choose a base branch
from
milanglacier:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -134,9 +134,9 @@ Check the [`./features.md`](./features.md) for more details. | |||||
|
||||||
- `-m`, `--model`: Specify Large Language Model to use. | ||||||
- `-f`, `--format`: Ask the LLM to format the response in a given format. | ||||||
- `--format-as`: Specify the format for the output (used with `--format`). | ||||||
- `-P`, `--prompt`: Prompt should include stdin and args. | ||||||
- `-p`, `--prompt-args`: Prompt should only include args. | ||||||
- `--format-as`: Specify the format for the output (used with `--format`, e.g. `mods -f --format-as json 'your prompt here'`). | ||||||
- `-P=n`, `--prompt=n`: show the output with prompts from stdin, and only include the first `n` lines of prompt. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
- `-p`, `--prompt-args`: show the prompt from args in the output. | ||||||
- `-q`, `--quiet`: Only output errors to standard err. | ||||||
- `-r`, `--raw`: Print raw response without syntax highlighting. | ||||||
- `-s`, `--settings`: Open settings. | ||||||
|
This file contains 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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -40,7 +40,7 @@ var help = map[string]string{ | |||||
"role": "System role to use.", | ||||||
"roles": "List of predefined system messages that can be used as roles.", | ||||||
"list-roles": "List the roles defined in your configuration file", | ||||||
"prompt": "Include the prompt from the arguments and stdin, truncate stdin to specified number of lines.", | ||||||
"prompt": "Include the top n lines of prompt from the stdin in the response, where n is the specified number.", | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
"prompt-args": "Include the prompt from the arguments in the response.", | ||||||
"raw": "Render output as raw text when connected to a TTY.", | ||||||
"quiet": "Quiet mode (hide the spinner while loading and stderr messages for success).", | ||||||
|
This file contains 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the other flags don't have example usages in their help, i think this should be somewhere else