Skip to content

Commit

Permalink
docs(installation): update descriptions for Bash (#64)
Browse files Browse the repository at this point in the history
The details are explained in the commit messages.
  • Loading branch information
akinomyoga authored Jul 15, 2024
1 parent 0352239 commit 2841ad9
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion src/content/docs/guide/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ After installing, remember to restart your shell.
<TabItem label="ble.sh">
Atuin works best in bash when using [ble.sh](https://github.com/akinomyoga/ble.sh).

With ble.sh installed, just add atuin to your .bashrc
With ble.sh installed and loaded in `~/.bashrc`, just add atuin to your `~/.bashrc`

```shell
echo 'eval "$(atuin init bash)"' >> ~/.bashrc
Expand All @@ -150,6 +150,14 @@ After installing, remember to restart your shell.
bash-preexec currently has an issue where it will stop honoring `ignorespace`.
While Atuin will ignore commands prefixed with whitespace, they may still end up in your bash history.
Please check your configuration! All other shells do not have this issue.

To use Atuin in `bash < 4` with bash-preexec, the option `enter_accept` needs
to be turned on (which is so by default).

bash-preexec cannot properly invoke the `preexec` hook for subshell commands
`(...)`, function definitions `func() { ...; }`, empty for-in-statements `for
i in; do ...; done`, etc., so those commands and duration may not be recorded
in the Atuin's history correctly.
</Aside>

To use bash-preexec, download and initialize it
Expand Down

0 comments on commit 2841ad9

Please sign in to comment.