diff options
| author | VuiMuich <jm.spam@gmx.net> | 2023-05-02 10:00:52 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-02 09:00:52 +0100 |
| commit | 5a0e63370a4177e7733f31b9d51ee6b90ec77982 (patch) | |
| tree | 3aca19e6f32a65292891ebdf0e70b26e6e2e55f6 /docs | |
| parent | cwd_filter: much like history_filter, only it applies to cwd (#904) (diff) | |
| download | atuin-5a0e63370a4177e7733f31b9d51ee6b90ec77982.zip | |
Add command flag for `inline_height` (#905)
* add a command flag for `inline_height`
* docs
* docs: better formating for short command flags
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/commands/list.md | 14 | ||||
| -rw-r--r-- | docs/docs/commands/search.md | 33 |
2 files changed, 25 insertions, 22 deletions
diff --git a/docs/docs/commands/list.md b/docs/docs/commands/list.md index 0aff88c1..c48d9d0a 100644 --- a/docs/docs/commands/list.md +++ b/docs/docs/commands/list.md @@ -5,13 +5,13 @@ title: Listing History # `atuin history list` -| Arg | Description | -| -------------- | ----------------------------------------------------------------------------- | -| `--cwd/-c` | The directory to list history for (default: all dirs) | -| `--session/-s` | Enable listing history for the current session only (default: false) | -| `--human` | Use human-readable formatting for the timestamp and duration (default: false) | -| `--cmd-only` | Show only the text of the command (default: false) | -| `--format` | Specify the formatting of a command (see below) | +| Arg | Description | +| ---------------- | ----------------------------------------------------------------------------- | +| `--cwd`/`-c` | The directory to list history for (default: all dirs) | +| `--session`/`-s` | Enable listing history for the current session only (default: false) | +| `--human` | Use human-readable formatting for the timestamp and duration (default: false) | +| `--cmd-only` | Show only the text of the command (default: false) | +| `--format` | Specify the formatting of a command (see below) | ## Format diff --git a/docs/docs/commands/search.md b/docs/docs/commands/search.md index f3217f07..cb815478 100644 --- a/docs/docs/commands/search.md +++ b/docs/docs/commands/search.md @@ -9,21 +9,24 @@ Atuin search 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` | 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) | -| `--delete` | Delete history matching this query | -| `--delete-it-all` | Delete all shell history | -| `--reverse` | Reverse order of search results, oldest first | +| 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` | 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) | +| `--delete` | Delete history matching this query | +| `--delete-it-all` | Delete all shell history | +| `--reverse` | Reverse order of search results, oldest first | +| `--format`/`-f` | Available vareables: {command}, {directory}, {duration}, {user}, {host}, {time}, {exit} and {relativetime}. Example: --format "{time} - [{duration}] - {directory}$\t{command}" | +| `--inline-height` | Set the maximum number of lines Atuin's interface should take up | +| `--help`/`-h` | Print help | ## `atuin search -i` |