diff options
Diffstat (limited to 'docs/search.md')
| -rw-r--r-- | docs/search.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/search.md b/docs/search.md new file mode 100644 index 00000000..b1034007 --- /dev/null +++ b/docs/search.md @@ -0,0 +1,39 @@ +# `atuin search` + +``` +atuin search <query> +``` + +Atuin search also supports wildcards, with either the `*` or `%` character. By +default, a prefix search is performed (ie, all queries are automatically +appended with a wildcard. + +| Arg | Description | +| ------------------ | ----------------------------------------------------------------------------- | +| `--cwd/-c` | The directory to list history for (default: all dirs) | +| `--exclude-cwd` | Do not include commands that ran in this directory (default: none) | +| `--exit/-e` | Filter by exit code (default: none) | +| `--exclude-exit` | Do not include commands that exited with this value (default: none) | +| `--before` | Only include commands ran before this time(default: none) | +| `--after` | Only include commands ran after this time(default: none) | +| `--interactive/-i` | Open the interactive search UI (default: false) | +| `--human/-h` | Use human-readable formatting for the timestamp and duration (default: false) | + +## Examples + +``` +# Open the interactive search TUI +atuin search -i + +# Open the interactive search TUI preloaded with a query +atuin search -i atuin + +# Search for all commands, beginning with cargo, that exited successfully +atuin search --exit 0 cargo + +# Search for all commands, that failed, from the current dir, and were ran before April 1st 2021 +atuin search --exclude-exit 0 --before 01/04/2021 --cwd . + +# Search for all commands, beginning with cargo, that exited successfully, and were ran after yesterday at 3pm +atuin search --exit 0 --after "yesterday 3pm" cargo +``` |