|
1 | 1 | # Options |
2 | 2 |
|
3 | | -| Option | Type | Description | |
4 | | -| ----------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | |
5 | | -| `--include` | String | Takes a comma delimited list of glob patterns to include for code blocks. | |
6 | | -| `--exclude` | String | Takes a comma delmited list of glob patterns to exclude for code blocks. | |
7 | | -| `--exclude-priority` | bool | In case if the include and exclude patterns conflict, this will determine which pattern to prioritize. By default the include patterns are prioritized. If this option is included, the the exclude patterns will be prioritized. | |
8 | | -| `--exclude-from-tree` | bool | Whether to exclude the files/directories from the source tree based on the exclude patterns. By default excluded files are included in the file tree. If this option is included, only explicitly included files will be in the file tree. | |
9 | | -| `--gitignore` | bool | Whether to respect the `.gitignore` file. By default, the patterns in the `.gitignore` file will be ignored. If this option is included, files in the `.gitignore` patterns will be included. | |
10 | | -| `-d`, `--diff-staged` | bool | Whether to capture the git diff for staged changes only (equivalent to running `git diff --staged`). | |
11 | | -| `-u`, `--diff-unstaged` | bool | Whether to capture the git diff for the unstaged changes only (equivalent to running `git diff`). | |
12 | | -| `--no-tokens` | bool | Whether to display the approximate token count for the generated prompt. If this option is included, this will toggle the token count off. | |
13 | | -| `c`, `--encoding` | String | The tokenizer to use for the approximate token count. Defaults to `cl100k`. | |
14 | | -| `-o`, `--output` | String | A file path can be passed with this option to dump the generated prompt to an output file. | |
15 | | -| `-l`, `--no-line-numbers` | bool | Whether to include toggle off the line numbers inside the markdown code blocks. | |
16 | | -| `--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. | |
17 | | -| `--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. | |
18 | | -| `--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. | |
19 | | -| `-t`, `--template` | String | The file path to the template to use for rendering. | |
20 | | -| `--spinner` | bool | Whether to render the progress spinner. If this option is included, the spinner will not be rendered. | |
21 | | -| `json` | bool | Whether to print the intermediate JSON. If this option is included, the JSON will be printed. | |
22 | | -| `--issue` | int | The github issue number to fetch. | |
23 | | -| `--verbose` | bool | Toggle verbose output for investigating glob pattern matching. | |
24 | | -| `-h`, `--help` | bool | Print the help message. | |
25 | | -| `-V`, `--version` | bool | Print the tool version. | |
| 3 | +| Option | Type | Description | |
| 4 | +| ------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | |
| 5 | +| `--include` | String | Takes a comma delimited list of glob patterns to include for code blocks. | |
| 6 | +| `--exclude` | String | Takes a comma delmited list of glob patterns to exclude for code blocks. | |
| 7 | +| `--exclude-priority` | bool | In case if the include and exclude patterns conflict, this will determine which pattern to prioritize. By default the include patterns are prioritized. If this option is included, the the exclude patterns will be prioritized. | |
| 8 | +| `--exclude-from-tree` | bool | Whether to exclude the files/directories from the source tree based on the exclude patterns. By default excluded files are included in the file tree. If this option is included, only explicitly included files will be in the file tree. | |
| 9 | +| `--gitignore` | bool | Whether to respect the `.gitignore` file. By default, the patterns in the `.gitignore` file will be ignored. If this option is included, files in the `.gitignore` patterns will be included. | |
| 10 | +| `-d`, `--diff-staged` | bool | Whether to capture the git diff for staged changes only (equivalent to running `git diff --staged`). | |
| 11 | +| `-u`, `--diff-unstaged` | bool | Whether to capture the git diff for the unstaged changes only (equivalent to running `git diff`). | |
| 12 | +| `--no-tokens` | bool | Whether to display the approximate token count for the generated prompt. If this option is included, this will toggle the token count off. | |
| 13 | +| `c`, `--encoding` | String | The tokenizer to use for the approximate token count. Defaults to `cl100k`. | |
| 14 | +| `-o`, `--output` | String | A file path can be passed with this option to dump the generated prompt to an output file. | |
| 15 | +| `-l`, `--no-line-numbers` | bool | Whether to include toggle off the line numbers inside the markdown code blocks. | |
| 16 | +| `--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. | |
| 17 | +| `--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. | |
| 18 | +| `--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. | |
| 19 | +| `-t`, `--template` | String | The file path to the template to use for rendering. | |
| 20 | +| `--spinner` | bool | Whether to render the progress spinner. If this option is included, the spinner will not be rendered. | |
| 21 | +| `json` | bool | Whether to print the intermediate JSON. If this option is included, the JSON will be printed. | |
| 22 | +| `--issue` | int | The github issue number to fetch. | |
| 23 | +| `--verbose` | bool | Toggle verbose output for investigating glob pattern matching. | |
| 24 | +| `--no-warnings` | bool | Ignore all warnings including sensitive files, large token counts, and template warnings. Useful for automated scripts and CI/CD pipelines. | |
| 25 | +| `-h`, `--help` | bool | Print the help message. | |
| 26 | +| `-V`, `--version` | bool | Print the tool version. | |
0 commit comments