extern/atuin
1
0
Fork 0
mirror of https://github.com/atuinsh/atuin.git synced 2025-06-25 12:21:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(bash-preexec): describe the limitation of missing commands (#1937)

Browse Source
This commit is contained in:
Koichi Murase 2024-04-09 20:41:31 +09:00 committed by GitHub
parent c384179814
commit 05becf9255
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 31 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -122,7 +122,13 @@ atuin sync
``` ```
Then restart your shell! Then restart your shell!
> [!NOTE]
>
> **For Bash users**: The above sets up `bash-preexec` for necessary hooks, but
> `bash-preexec` has limitations. For details, please see the [Bash](#bash)
> section below.
## Offline only (no sync) ## Offline only (no sync)
``` ```
@ -287,11 +293,15 @@ With ble.sh (>= 0.4) installed, just add atuin to your .bashrc
echo 'eval "$(atuin init bash)"' >> ~/.bashrc echo 'eval "$(atuin init bash)"' >> ~/.bashrc
``` ```
Please make sure that the above line comes after sourcing ble.sh so atuin knows the presence of ble.sh. > [!IMPORTANT]
>
> Please make sure that the above line comes after sourcing ble.sh, so Atuin detects ble.sh.
#### [bash-preexec](https://github.com/rcaloras/bash-preexec) #### [bash-preexec](https://github.com/rcaloras/bash-preexec)
[Bash-preexec](https://github.com/rcaloras/bash-preexec) can also be used, but you may experience some minor problems with the recorded duration and exit status of some commands. [Bash-preexec](https://github.com/rcaloras/bash-preexec) can also be used, but
you may experience minor problems of missing commands, ignored `HISTCONTROL`,
wrong recorded duration and exit status of some commands.
To use bash-preexec, download and initialize it To use bash-preexec, download and initialize it
@ -306,11 +316,25 @@ Then set up Atuin
echo 'eval "$(atuin init bash)"' >> ~/.bashrc echo 'eval "$(atuin init bash)"' >> ~/.bashrc
``` ```
**PLEASE NOTE** > [!NOTE]
>
> 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 may not be recorded in the
> Atuin's history.
>
> bash-preexec currently has an issue where it will stop honoring
> `HISTCONTROL=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.
>
> Also, there can be problems in the recorded duration and the exit status of
> some commands.
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. > [!IMPORTANT]
>
To use Atuin in `bash < 4` with bash-preexec, the option `enter_accept` needs to be turned on (which is so by default). > To use Atuin in `bash < 4` with bash-preexec, the option `enter_accept` needs
> to be turned on (which is so by default).
### fish ### fish