Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions src/content/docs/configuration/config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -433,7 +433,7 @@ most basic one. In the keymap mode `"vim-normal"`, you may use <kbd>k</kbd>
and <kbd>j</kbd> to navigate the history list as in Vim, whilst pressing
<kbd>i</kbd> 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 <kbd>
Esc
Esc
</kbd> 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
Expand Down Expand Up @@ -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 = [...]
Expand Down Expand Up @@ -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

Expand All @@ -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'
Expand All @@ -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 = [...]
```
Expand Down Expand Up @@ -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
Expand Down
11 changes: 6 additions & 5 deletions src/content/docs/configuration/key-binding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ You can also disable either the up-arrow or <kbd>Ctrl-r</kbd> 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)"

Expand Down Expand Up @@ -71,7 +72,7 @@ can be used for the keybindings to the <kbd>up</kbd> 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)"

Expand All @@ -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 <kbd>up</kbd> key or similar keys.

```
```bash
export ATUIN_NOBIND="true"
eval "$(atuin init bash)"

Expand All @@ -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

Expand Down Expand Up @@ -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 |
| -------- | --------------------------------------------- |
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Add `--disable-up-arrow`

EG:

```
```bash
eval "$(atuin init zsh --disable-up-arrow)"
```

Expand All @@ -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
```

Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/guide/basic-usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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"
```
40 changes: 20 additions & 20 deletions src/content/docs/guide/dotfiles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
Expand All @@ -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
```
Expand All @@ -43,69 +43,69 @@ 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'
```

### Deleting an alias

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
```

### Listing aliases

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'
```

Expand All @@ -114,28 +114,28 @@ 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
```

### Listing vars

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
```

Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/guide/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ 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 <USERNAME> -e <EMAIL>
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
Expand All @@ -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
Expand Down
5 changes: 3 additions & 2 deletions src/content/docs/guide/import.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
Loading