Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rostrovsky committed Sep 12, 2024
1 parent 7d81a4a commit 34763f2
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ go install github.com/rostrovsky/sourceprompt@latest

## Flags

* `-i, --include` - Regex pattern of paths that should be included.
* `-e, --exclude` - Regex pattern of paths that should be excluded.
* `-i, --include` - Regex patterns of paths that should be included.
* `-e, --exclude` - Regex patterns of paths that should be excluded.
* `-o, --output` - Output file path. When not specified, output will be printed to `stdout`.
* `-p, --prompt` - Prompt file path or URL. Allows specifying custom prompt which will be put at the beginning of the output. **If not specified, [default prompt](#default-prompt) will be used.**
* `-r, --raw` - Removes prompt from the output.
Expand Down Expand Up @@ -53,8 +53,14 @@ sourceprompt /path/to/dir -o out.md -p my_prompt.txt
# include only src/ files
sourceprompt /path/to/dir -o out.md -i '^src'

# include only C source files
sourceprompt /path/to/dir -o out.md -i '.c$' -i '.h$'

# exclude markdown files
sourceprompt /path/to/dir -o out.md -e '\.md$'

# exclude multiple types
sourceprompt /path/to/dir -o out.md -e '.md$' -e '.txt$' -e 'LICENSE'
```

## Default prompt
Expand Down

0 comments on commit 34763f2

Please sign in to comment.