Skip to content

Commit

Permalink
update documentation for verbose option
Browse files Browse the repository at this point in the history
  • Loading branch information
@seankim658
seankim658 committed Jul 19, 2024
1 parent 462146f commit 5c9d3ab
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 13 deletions.
7 changes: 5 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,10 @@ Options:
Whether to respect the .gitignore file. Defaults to True
-d, --diff-staged
Whether to capture the git diff for staged changes only (equivalaent to running `git diff --cached` or `git diff --staged`. Defaults to False
Whether to capture the git diff for staged changes only (equivalent to running `git diff --cached` or `git diff --staged`. Defaults to False
-u, --diff-unstaged
Whether to capture the git diff for unstaged changes only (equivalaent to running `git diff`). Defaults to False
Whether to capture the git diff for unstaged changes only (equivalent to running `git diff`). Defaults to False
--tokens
Display approximate token count of the genrated prompt. Defaults to True
Expand Down Expand Up @@ -128,6 +128,9 @@ Options:
--issue <ISSUE>
Fetch a specific Github issue for the repository
--verbose
Run in verbose mode to investigate glob pattern matching
-h, --help
Print help (see a summary with '-h')
Expand Down
21 changes: 11 additions & 10 deletions docs/options.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,22 @@
| ----------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--include` | String | Takes a comma delimited list of glob patterns to include for code blocks. |
| `--exclude` | String | Takes a comma delmited list of glob patterns to exclude for code blocks. |
| `--include-priority` | bool | In case if the include and exclude patterns conflict, this will determine which pattern to prioritize. By not including the option, the flag is set to `True` indicating to prioritize the include patterns. If you include this option, the flag will be set to `False` and the exclude pattern will be prioritized. |
| `--exclude-from-tree` | bool | Whether to exclude the files/directories from the source tree based on the exclude patterns. By not including the option, the flag defaults to `False`. If you include this option, the flag will be set to `True`. |
| `--gitignore` | bool | Whether to respect the `.gitignore` file. By not including the option, the flag defaults to `True` and the patterns in the `.gitignore` file will be ignored. If you include this option, the flag will be set to `False` and the files matched in `.gitignore` patterns will be included. |
| `--include-priority` | bool | In case if the include and exclude patterns conflict, this will determine which pattern to prioritize. By not including the option, the flag is set to `True` indicating to prioritize the include patterns. If this option is included, the flag will be set to `False` and the exclude pattern will be prioritized. |
| `--exclude-from-tree` | bool | Whether to exclude the files/directories from the source tree based on the exclude patterns. By not including the option, the flag defaults to `False`. If this option is included, the flag will be set to `True`. |
| `--gitignore` | bool | Whether to respect the `.gitignore` file. By not including the option, the flag defaults to `True` and the patterns in the `.gitignore` file will be ignored. If this option is included, the flag will be set to `False` and the files matched in `.gitignore` patterns will be included. |
| `-d`, `--diff-staged` | bool | Whether to capture the git diff for staged changes only (equivalent to running `git diff --staged`). |
| `-u`, `--diff-unstaged` | bool | Whether to capture the git diff for the unstaged changes only (equivalent to running `git diff`). |
| `--tokens` | bool | Whether to display the approximate token count for the generated prompt. If you include this option, the tokens will not be generated. |
| `--tokens` | bool | Whether to display the approximate token count for the generated prompt. If this option is included, the token count will not be generated. |
| `c`, `--encoding` | String | The tokenizer to use for the approximate token count. Defaults to `cl100k`. |
| `-o`, `--output` | String | A file path can be passed with this option to dump the generated prompt to an output file. |
| `-l`, `--line-numbers` | bool | Whether to include the line numbers inside the markdown code blocks. If you include this option, the line numebrs will not be generated. |
| `--no-codeblock` | bool | Whether or not to wrap the code blocks inside markdown code blocks. If you include this option, the code will not be wrapped in markdown code blocks. |
| `--relative-paths` | bool | Toggle whether to render relative paths or absolute paths in the generated prompt. If you include this option, the absolute paths will be used. |
| `--no-clipboard` | bool | Whether to copy the generated prompt to the clipboard. If you include this option, the output will not be automatically copied to the clipboard. |
| `-l`, `--line-numbers` | bool | Whether to include the line numbers inside the markdown code blocks. If this option is included, the line numebrs will not be generated. |
| `--no-codeblock` | bool | Whether or not to wrap the code blocks inside markdown code blocks. If this option is included, the code will not be wrapped in markdown code blocks. |
| `--relative-paths` | bool | Toggle whether to render relative paths or absolute paths in the generated prompt. If this option is included, the absolute paths will be used. |
| `--no-clipboard` | bool | Whether to copy the generated prompt to the clipboard. If this option is included, the output will not be automatically copied to the clipboard. |
| `-t`, `--template` | String | The file path to the template to use for rendering. |
| `--spinner` | bool | Whether to render the progress spinner. If you include this option, the spinner will not be rendered. |
| `json` | bool | Whether to print the intermediate JSON. If you include this option, the JSON will be printed. |
| `--spinner` | bool | Whether to render the progress spinner. If this option is included, the spinner will not be rendered. |
| `json` | bool | Whether to print the intermediate JSON. If this option is included, the JSON will be printed. |
| `--issue` | int | The github issue number to fetch. |
| `--verbose` | bool | Toggle verbose output for investigating glob pattern matching. |
| `-h`, `--help` | bool | Print the help message. |
| `-V`, `--version` | bool | Print the tool version. |
2 changes: 1 addition & 1 deletion src/main.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ struct Args {
#[arg(long)]
issue: Option<u32>,

/// Run in verbose mode to investigate glob pattern matching.
/// Run in verbose mode to investigate glob pattern matching. Defaults to False.
#[arg(long, action(ArgAction::SetTrue))]
verbose: bool
}
Expand Down

0 comments on commit 5c9d3ab

Please sign in to comment.