myriation/atuin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update docs (#1367)

Browse source
This commit is contained in:
Ellie Huxtable 2023-11-01 19:25:04 +00:00 committed by GitHub
parent 8ac090a810
commit 61d05d04e9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/docs/guide/index.md
View file

@ -165,4 +165,6 @@ curl https://api.atuin.sh/enable -d $(cat ~/.local/share/atuin/session)
The response includes the URL to your graph. Feel free to share and/or embed The response includes the URL to your graph. Feel free to share and/or embed
this URL, the token is _not_ a secret, and simply prevents user enumeration. this URL, the token is _not_ a secret, and simply prevents user enumeration.
## Known issues
- SQLite has some issues with ZFS in certain configurations. As Atuin uses SQLite, this may cause your shell to become slow! We have an [issue](https://github.com/atuinsh/atuin/issues/952) to track, with some workarounds
- SQLite also does not tend to like network filesystems (eg, NFS)

3
docs/docs/key-binding.md
View file

@ -136,6 +136,8 @@ $env.config = (
| Shortcut | Action | | Shortcut | Action |
| ----------------------------------------- | ----------------------------------------------------------------------------- | | ----------------------------------------- | ----------------------------------------------------------------------------- |
| enter | Execute selected item |
| tab | Select item and edit |
| ctrl + r | Cycle through filter modes | | ctrl + r | Cycle through filter modes |
| ctrl + s | Cycle through search modes | | ctrl + s | Cycle through search modes |
| alt + 1 to alt + 9 | Select item by the number located near it | | alt + 1 to alt + 9 | Select item by the number located near it |
@ -155,7 +157,6 @@ $env.config = (
| ctrl + p / ctrl + k / ⬇ | Select the previous item on the list | | ctrl + p / ctrl + k / ⬇ | Select the previous item on the list |
| page down | Scroll search results one page down | | page down | Scroll search results one page down |
| page up | Scroll search results one page up | | page up | Scroll search results one page up |
| enter | Select highlighted item |
| ⬇ (with no entry selected) | Return original or return query depending on settings | | ⬇ (with no entry selected) | Return original or return query depending on settings |
| ⬇ | Select the next item on the list | | ⬇ | Select the next item on the list |