From 5a0e63370a4177e7733f31b9d51ee6b90ec77982 Mon Sep 17 00:00:00 2001 From: VuiMuich Date: Tue, 2 May 2023 10:00:52 +0200 Subject: Add command flag for `inline_height` (#905) * add a command flag for `inline_height` * docs * docs: better formating for short command flags --- atuin/src/command/client/search.rs | 7 +++++++ docs/docs/commands/list.md | 14 +++++++------- docs/docs/commands/search.md | 33 ++++++++++++++++++--------------- 3 files changed, 32 insertions(+), 22 deletions(-) diff --git a/atuin/src/command/client/search.rs b/atuin/src/command/client/search.rs index 7dbb9c43..ff7511d7 100644 --- a/atuin/src/command/client/search.rs +++ b/atuin/src/command/client/search.rs @@ -96,6 +96,10 @@ pub struct Cmd { /// Example: --format "{time} - [{duration}] - {directory}$\t{command}" #[arg(long, short)] format: Option, + + /// Set the maximum number of lines Atuin's interface should take up. + #[arg(long = "inline-height")] + inline_height: Option, } impl Cmd { @@ -118,6 +122,9 @@ impl Cmd { if self.filter_mode.is_some() { settings.filter_mode = self.filter_mode.unwrap(); } + if self.inline_height.is_some() { + settings.inline_height = self.inline_height.unwrap(); + } settings.shell_up_key_binding = self.shell_up_key_binding; 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` -- cgit v1.2.3