Skip to content

docs: clarify glob argument and shell expansion behavior #287

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.

Sign up for GitHub

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

Open
LarytheLord wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify glob argument and shell expansion behavior #287

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,10 @@ No findings found.
### File globs

By default, `woke` will run against all text files in your current directory.
To change this, supply a space-separated list of globs as the first argument.
To change this, supply a space-separated list of file paths or glob patterns as positional arguments.

This can be something like `**/*.go`, or a space-separated list of filenames.
For shell-expanded patterns, this can be something like `**/*.go`, or a space-separated list of filenames.
Globs are expanded by your shell before `woke` runs, so behavior may vary by shell and shell options.

```bash
$ woke test.txt
Expand Down