myriation/atuin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update atuin search docs (#828)

Browse source 
Add docs for using `--limit` and `--offset` in `atuin search`
This commit is contained in:
Tom Cammann 2023-03-29 20:41:28 +01:00 committed by GitHub
parent fa0a1447a6
commit ca5e58ad01
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/docs/commands/search.md
View file

@ -19,6 +19,8 @@ appended with a wildcard).
| `--after` | Only include commands ran after this time(default: none) |
| `--interactive/-i` | Open the interactive search UI (default: false) |
| `--human` | Use human-readable formatting for the timestamp and duration (default: false) |
| `--limit` | Limit the number of results (default: none) |
| `--offset` | Offset from the start of the results (default: none) |
## Examples
@ -37,4 +39,10 @@ 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
# Search for a command beginning with cargo, return exactly one result.
atuin search --limit 1 cargo
# Search for a single result for a command beginning with cargo, skipping (offsetting) one result
atuin search --offset 1 --limit cargo
```