From ca5e58ad0191fed6000433c1e56f7d0c555653e6 Mon Sep 17 00:00:00 2001 From: Tom Cammann Date: Wed, 29 Mar 2023 20:41:28 +0100 Subject: [PATCH] Update `atuin search` docs (#828) Add docs for using `--limit` and `--offset` in `atuin search` --- docs/docs/commands/search.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/docs/commands/search.md b/docs/docs/commands/search.md index 74209b0..21074be 100644 --- a/docs/docs/commands/search.md +++ b/docs/docs/commands/search.md @@ -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 ```