diff --git a/src/content/docs/configuration/config.mdx b/src/content/docs/configuration/config.mdx index 2993b50..c02d376 100644 --- a/src/content/docs/configuration/config.mdx +++ b/src/content/docs/configuration/config.mdx @@ -161,7 +161,7 @@ Atuin version: >= 17.0 Default: `fuzzy` -The default searchmode to use when searching and being invoked from a shell up-key binding. +The default search mode to use when searching and being invoked from a shell up-key binding. Accepts exactly the same options as `search_mode` above @@ -356,7 +356,7 @@ secrets_filter = true This matches history against a set of default regex, and will not save it if we get a match. Defaults include 1. AWS key id -2. Github pat (old and new) +2. GitHub pat (old and new) 3. Slack oauth tokens (bot, user) 4. Slack webhooks 5. Stripe live/test keys @@ -433,7 +433,7 @@ most basic one. In the keymap mode `"vim-normal"`, you may use k and j to navigate the history list as in Vim, whilst pressing i changes the keymap mode to `"vim-insert"`. In the keymap mode `"vim-insert"`, you can search for a string as in the keymap mode `"emacs"`, while pressing - Esc + Esc switches the keymap mode to `"vim-normal"`. When set to `"auto"`, the initial keymap mode is automatically determined based on the shell's keymap that triggered the Atuin search. `"auto"` is not supported by NuShell at present, where it will @@ -477,7 +477,7 @@ Alternatively, set env var NO_MOTION This section of client config is specifically for configuring Atuin stats calculations -``` +```toml [stats] common_subcommands = [...] common_prefix = [...] @@ -559,7 +559,7 @@ Note: you will need to have sync v2 enabled. See the above section. Manage aliases using the command line options -``` +```bash # Alias 'k' to 'kubectl' atuin dotfiles alias set k kubectl @@ -570,13 +570,13 @@ atuin dotfiles alias list atuin dotfiles alias delete k ``` -After setting an alias, you will either need to restart your shell or source the init file for the change to take affect +After setting an alias, you will either need to restart your shell or source the init file for the change to take effect ## keys This section of the client config is specifically for configuring key-related settings. -``` +```toml [keys] scroll_exits = [...] prefix = 'a' @@ -603,7 +603,7 @@ Which key to use as the prefix This section of the client config is specifically for configuring preview-related settings. (In the future the other 2 preview settings will be moved here.) -``` +```toml [preview] strategy = [...] ``` @@ -700,7 +700,7 @@ Default: `""` A theme name that must be present as a built-in (an empty string for the default, `autumn` or `marine`), or found in the themes directory, with the suffix `.toml`. -By default this is `~/.config/atuin/themes/` but can be overridden with the +By default, this is `~/.config/atuin/themes/` but can be overridden with the `ATUIN_THEME_DIR` environment variable. ```toml diff --git a/src/content/docs/configuration/key-binding.mdx b/src/content/docs/configuration/key-binding.mdx index bbe5b74..b5cc50b 100644 --- a/src/content/docs/configuration/key-binding.mdx +++ b/src/content/docs/configuration/key-binding.mdx @@ -26,7 +26,8 @@ You can also disable either the up-arrow or Ctrl-r bindings individua `--disable-up-arrow` or `--disable-ctrl-r` to the call to `atuin init` in your shell config file: An example for zsh: -``` + +```zsh # Bind ctrl-r but not up arrow eval "$(atuin init zsh --disable-up-arrow)" @@ -71,7 +72,7 @@ can be used for the keybindings to the up key and similar keys. Note: instead use the widget names "\_atuin\_search\_widget" and "\_atuin\_up\_search\_widget", respectively, in `atuin < 18.0` -``` +```zsh export ATUIN_NOBIND="true" eval "$(atuin init zsh)" @@ -94,7 +95,7 @@ Atuin provides a bindable shell function "`__atuin_history`" for keybindings in Bash. The flag `--shell-up-key-binding` can be optionally specified to the first argument for keybindings to the up key or similar keys. -``` +```bash export ATUIN_NOBIND="true" eval "$(atuin init bash)" @@ -116,7 +117,7 @@ combination with the config ## fish Edit key bindings in FISH shell by adding the following to ~/.config/fish/config.fish -``` +```fish set -gx ATUIN_NOBIND "true" atuin init fish | source @@ -201,7 +202,7 @@ If [vim is enabled in the config](https://docs.atuin.sh/configuration/config/#vi ### Inspector -Open the inspector with ctrl-o +Open the inspector with ctrl-o | Shortcut | Action | | -------- | --------------------------------------------- | diff --git a/src/content/docs/faq.mdx b/src/content/docs/faq.mdx index ccb621a..2adb37d 100644 --- a/src/content/docs/faq.mdx +++ b/src/content/docs/faq.mdx @@ -10,7 +10,7 @@ Add `--disable-up-arrow` EG: -``` +```bash eval "$(atuin init zsh --disable-up-arrow)" ``` @@ -26,7 +26,7 @@ You can make `enter` edit a command by putting `enter_accept = false` into your **Attention:** This command does not prompt for confirmation. -``` +```bash atuin account delete ``` diff --git a/src/content/docs/guide/basic-usage.mdx b/src/content/docs/guide/basic-usage.mdx index 214efeb..98c99bc 100644 --- a/src/content/docs/guide/basic-usage.mdx +++ b/src/content/docs/guide/basic-usage.mdx @@ -44,7 +44,7 @@ Read more [here](/configuration/key-binding/) You may prefer that Atuin always inserts the selected command for editing. To configure this, set -``` +```toml enter_accept = false ``` @@ -54,13 +54,13 @@ in your config file. If you find the full screen TUI overwhelming or too much, you can adjust it like so -``` +```toml # height of the search window inline_height = 40 ``` You may also prefer the compact UI mode -``` +```toml style = "compact" ``` diff --git a/src/content/docs/guide/dotfiles.mdx b/src/content/docs/guide/dotfiles.mdx index cbd5d9c..921f5cd 100644 --- a/src/content/docs/guide/dotfiles.mdx +++ b/src/content/docs/guide/dotfiles.mdx @@ -9,7 +9,7 @@ to work with. At the moment, we support managing and syncing of shell aliases and environment variables - with more coming soon. -The following shells are supported: +The following shells are supported: - zsh - bash @@ -23,7 +23,7 @@ no longer need to edit your config files manually. Once Atuin is setup and installed, the following is required in your config file (`~/.config/atuin/config.toml`) -``` +```toml [dotfiles] enabled = true ``` @@ -32,7 +32,7 @@ In a later release, this will be enabled by default. Note: If you have not yet setup sync v2, please also add -``` +```toml [sync] records = true ``` @@ -43,24 +43,24 @@ to the same config file. ## Aliases -After creating or deleting an alias, remember to restart your shell! +After creating or deleting an alias, remember to restart your shell! ### Creating an alias -``` +```bash atuin dotfiles alias set NAME 'COMMAND' ``` For example, to alias `k` to be `kubectl` -``` +```bash atuin dotfiles alias set k 'kubectl' ``` or to alias `ll` to be `ls -lah` -``` +```bash atuin dotfiles alias set ll 'ls -lah' ``` @@ -68,13 +68,13 @@ atuin dotfiles alias set ll 'ls -lah' Deleting an alias is as simple as: -``` +```bash atuin dotfiles alias delete NAME ``` For example, to delete the above alias `k`: -``` +```bash atuin dotfiles alias delete k ``` @@ -82,30 +82,30 @@ atuin dotfiles alias delete k You can list all aliases with: -``` +```bash atuin dotfiles alias list ``` ## Env vars -After creating or deleting an env var, remember to restart your shell! +After creating or deleting an env var, remember to restart your shell! -### Creating a var +### Creating a var -``` +```bash atuin dotfiles var set NAME 'value' ``` For example, to set `FOO` to be `bar` -``` +```bash atuin dotfiles var set FOO 'bar' ``` Vars are exported by default, but you can create a shell var like so -``` +```bash atuin dotfiles var set -n foo 'bar' ``` @@ -114,13 +114,13 @@ atuin dotfiles var set -n foo 'bar' Deleting a var is as simple as: -``` +```bash atuin dotfiles var delete NAME ``` For example, to delete the above var `FOO`: -``` +```bash atuin dotfiles var delete FOO ``` @@ -128,14 +128,14 @@ atuin dotfiles var delete FOO You can list all vars with: -``` +```bash atuin dotfiles var list ``` ## Syncing and backing up dotfiles -If you have [setup sync](/guide/sync), then running +If you have [setup sync](/guide/sync), then running -``` +```bash atuin sync ``` diff --git a/src/content/docs/guide/getting-started.mdx b/src/content/docs/guide/getting-started.mdx index de02f1f..04ff51c 100644 --- a/src/content/docs/guide/getting-started.mdx +++ b/src/content/docs/guide/getting-started.mdx @@ -28,7 +28,7 @@ If you have any problems, please open an [issue](https://github.com/ellie/atuin/ Please do try and read this guide, but if you're in a hurry and want to get started quickly: -``` +```bash bash <(curl --proto '=https' --tlsv1.2 -sSf https://setup.atuin.sh) atuin register -u -e @@ -36,7 +36,7 @@ atuin import auto atuin sync ``` -Now restart your shell! +Now restart your shell! Anytime you press ctrl-r or up, you will see the Atuin search UI. Type your query, enter to execute. If you'd like to select a command without executing @@ -48,7 +48,7 @@ bindings](https://atuin.sh/docs/key-binding#disable-up-arrow) Note: The above sync and registration is fully optional. If you'd like to use Atuin offline, you can run -``` +```bash bash <(curl --proto '=https' --tlsv1.2 -sSf https://setup.atuin.sh) atuin import auto diff --git a/src/content/docs/guide/import.mdx b/src/content/docs/guide/import.mdx index 205f750..4262a19 100644 --- a/src/content/docs/guide/import.mdx +++ b/src/content/docs/guide/import.mdx @@ -6,13 +6,14 @@ Atuin uses a shell plugin to ensure that we capture new shell history. But for older history, you will need to import it This will import the history for your current shell: -``` + +```bash atuin import auto ``` Alternatively, you can specify the shell like so: -``` +```bash atuin import bash atuin import zsh # etc ``` diff --git a/src/content/docs/guide/sync.mdx b/src/content/docs/guide/sync.mdx index 9a3695e..94f7165 100644 --- a/src/content/docs/guide/sync.mdx +++ b/src/content/docs/guide/sync.mdx @@ -14,14 +14,14 @@ proceed to [login](#login). ## Register -``` +```bash atuin register -u -e ``` After registration, Atuin will generate an encryption key for you and store it locally. This is needed for logging in to other machines, and can be seen with -``` +```bash atuin key ``` @@ -37,14 +37,14 @@ By default, Atuin will sync your history once per hour. This can be To run a sync manually, please run -``` +```bash atuin sync ``` Atuin tries to be smart with a sync, and not waste data transfer. However, if you are seeing some missing data, please try running -``` +```bash atuin sync -f ``` @@ -61,7 +61,7 @@ note of your key. You can see this with `atuin key`. Then, install Atuin on a new machine. Once installed, login with -``` +```bash atuin login -u ``` @@ -69,12 +69,12 @@ You will be prompted for your password, and for your key. Syncing will happen automatically in the background, but you may wish to run it manually with -``` +```bash atuin sync ``` Or, if you see missing data, force a full sync with: -``` +```bash atuin sync -f ``` diff --git a/src/content/docs/guide/theming.mdx b/src/content/docs/guide/theming.mdx index 1e66eef..90a47f1 100644 --- a/src/content/docs/guide/theming.mdx +++ b/src/content/docs/guide/theming.mdx @@ -12,7 +12,7 @@ Atuin ships with only a couple of built-in alternative themes, but more can be a The following is required in your config file (`~/.config/atuin/config.toml`) -``` +```toml [theme] name = "THEMENAME" ``` @@ -28,7 +28,7 @@ will need to download themes or make your own. If you are writing your own themes, you can add the following line to get additional output: -``` +```toml debug = true ``` @@ -95,7 +95,6 @@ parent = "autumn" [colors] AlertInfo = "green" Guidance = "#888844" - ``` where not all of the *Meanings* need to be explicitly defined. If they are absent, @@ -105,7 +104,7 @@ key is missing in the `theme` block, from the default theme. This theme file should be moved to `~/.config/atuin/themes/my-theme.toml` and the following added to `~/.config/atuin/config.toml`: -``` +```toml [theme] name = "my-theme" ``` diff --git a/src/content/docs/reference/gen-completions.mdx b/src/content/docs/reference/gen-completions.mdx index e34bd95..3e4c971 100644 --- a/src/content/docs/reference/gen-completions.mdx +++ b/src/content/docs/reference/gen-completions.mdx @@ -4,7 +4,7 @@ title: gen-completions [Shell completions](https://en.wikipedia.org/wiki/Command-line_completion) for Atuin can be generated by specifying the output directory and desired shell via `gen-completions` subcommand. -``` +```bash $ atuin gen-completions --shell bash --out-dir $HOME Shell completion for BASH is generated in "/home/user" diff --git a/src/content/docs/reference/import.mdx b/src/content/docs/reference/import.mdx index de7a648..f8f8626 100644 --- a/src/content/docs/reference/import.mdx +++ b/src/content/docs/reference/import.mdx @@ -20,7 +20,7 @@ HISTFILE=/path/to/history/file atuin import zsh ``` Note that for shells such as Xonsh that store history in many files rather than a -single file, `$HISTFILE` should be set to the directory in whic those files reside. +single file, `$HISTFILE` should be set to the directory in which those files reside. For formats that don't store timestamps, timestamps will be generated starting at the current time plus 1ms for each additional command in the history. diff --git a/src/content/docs/reference/list.mdx b/src/content/docs/reference/list.mdx index ece03d0..9843666 100644 --- a/src/content/docs/reference/list.mdx +++ b/src/content/docs/reference/list.mdx @@ -22,7 +22,7 @@ Customize the output of `history list` Example -``` +```bash atuin history list --format "{time} - {duration} - {command}" ``` diff --git a/src/content/docs/reference/search.md b/src/content/docs/reference/search.md index 14eeedf..8e96fa6 100644 --- a/src/content/docs/reference/search.md +++ b/src/content/docs/reference/search.md @@ -6,24 +6,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 variables: {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 | +| `--inline-height` | Set the maximum number of lines Atuin's interface should take up | +| `--help`/`-h` | Print help | ## `atuin search -i` @@ -37,7 +37,7 @@ Note: This is not yet supported on macOS. ## Examples -``` +```bash # Open the interactive search TUI atuin search -i diff --git a/src/content/docs/reference/stats.mdx b/src/content/docs/reference/stats.mdx index 3fe9e1a..45ebb8d 100644 --- a/src/content/docs/reference/stats.mdx +++ b/src/content/docs/reference/stats.mdx @@ -13,7 +13,7 @@ for full or relative dates. Certain formats rely on the dialect option in your [configuration](/configuration/config#dialect) to differentiate day from month. Refer to [the module's documentation](https://docs.rs/interim/0.1.0/interim/#supported-formats) for more details on the supported date formats. -``` +```bash $ atuin stats last friday +---------------------+------------+ @@ -35,7 +35,7 @@ $ atuin stats last thursday 3pm # between last thursday 3:00pm and the followin ## Full history stats -``` +```bash $ atuin stats # or $ atuin stats all diff --git a/src/content/docs/reference/sync.mdx b/src/content/docs/reference/sync.mdx index 5225160..ac13160 100644 --- a/src/content/docs/reference/sync.mdx +++ b/src/content/docs/reference/sync.mdx @@ -24,7 +24,7 @@ You can manually trigger a sync with `atuin sync` Register for a sync account with -``` +```bash atuin register -u -e -p ``` @@ -41,7 +41,7 @@ here! You can delete your sync account with -``` +```bash atuin account delete ``` @@ -54,7 +54,7 @@ Atuin data directory (`~/.local/share/atuin` on Linux). You can also get this with -``` +```bash atuin key ``` @@ -65,7 +65,7 @@ Never share this with anyone! If you want to log in to a new machine, you will require your encryption key (`atuin key`). -``` +```bash atuin login -u -p -k ``` @@ -74,6 +74,6 @@ the password flag and you will be prompted to provide it through stdin. ## Logout -``` +```bash atuin logout ``` diff --git a/src/content/docs/self-hosting/docker.mdx b/src/content/docs/self-hosting/docker.mdx index 507efc3..09a511e 100644 --- a/src/content/docs/self-hosting/docker.mdx +++ b/src/content/docs/self-hosting/docker.mdx @@ -95,7 +95,7 @@ Start and enable the service with: systemctl enable --now atuin ``` -Check if its running with: +Check if it's running with: ```sh systemctl status atuin diff --git a/src/content/docs/self-hosting/kubernetes.mdx b/src/content/docs/self-hosting/kubernetes.mdx index 7ee3700..2ab6ff8 100644 --- a/src/content/docs/self-hosting/kubernetes.mdx +++ b/src/content/docs/self-hosting/kubernetes.mdx @@ -231,7 +231,7 @@ Note that this configuration will store the database folder _outside_ the kubern You should also change the password string in `ATUIN_DB_PASSWORD` and `ATUIN_DB_URI` in the`secrets.yaml` file to a more secure one. -The atuin service on the port `30530` of the host system. That is configured by the `nodePort` property. Kubernetes has a strict rule that you are not allowed to expose a port numbered lower than 30000. To make the clients work, you can simply set the port in in your `config.toml` file, e.g. `sync_address = "http://192.168.1.10:30530"`. +The atuin service on the port `30530` of the host system. That is configured by the `nodePort` property. Kubernetes has a strict rule that you are not allowed to expose a port numbered lower than 30000. To make the clients work, you can simply set the port in your `config.toml` file, e.g. `sync_address = "http://192.168.1.10:30530"`. Deploy the Atuin server using `kubectl`: @@ -290,4 +290,4 @@ spec: Configure/update the example `yaml` with the following: - Set a more or less frequent schedule with the `schedule` property. - Replace `/somewhere/on/node/for/database-backups` with a path on your node or reconfigure to use a `PersistentVolume` instead of `hostPath`. -- `--format=c` ouputs a format that can be restored with `pg_restore`. Use [`plain`](https://www.postgresql.org/docs/current/app-pgdump.html) if you want `.sql` files outputted instead. +- `--format=c` outputs a format that can be restored with `pg_restore`. Use [`plain`](https://www.postgresql.org/docs/current/app-pgdump.html) if you want `.sql` files outputted instead. diff --git a/src/content/docs/uninstall.md b/src/content/docs/uninstall.md index 1cddfc8..b7948e3 100644 --- a/src/content/docs/uninstall.md +++ b/src/content/docs/uninstall.md @@ -10,11 +10,11 @@ If you used the Atuin installer, you can totally delete it by removing the follo 2. Delete the ~/.local/share/atuin directory 3. Remove the line referencing "atuin init" from your shell config -Otherwise, uninstalling Atuin depends on your system, and how you installed it. +Otherwise, uninstalling Atuin depends on your system, and how you installed it. EG, on macOS, you'd want to run -``` +```bash brew uninstall atuin ```