Skip to content

Commit

Permalink
docs: add faq, offline install
Browse files Browse the repository at this point in the history
  • Loading branch information
ellie committed Jan 12, 2024
1 parent c501680 commit 6d9eb4d
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 0 deletions.
1 change: 1 addition & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ export default defineConfig({
},
{ label: 'Known issues', link: '/known-issues' },
{ label: 'Integrations', link: '/integrations' },
{ label: 'FAQ', link: '/faq' },
],
}),
],
Expand Down
23 changes: 23 additions & 0 deletions src/content/docs/faq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: FAQ
---

## How do I remove the default up arrow binding?

Open your shell config file, find the line containing `atuin init`.

Add `--disable-up-arrow`

EG:

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

See [key binding](https://docs.atuin.sh/configuration/key-binding/) for more

## How do I edit a command instead of running it immediately?

Press tab! By default, enter will execute a command, and tab will insert it ready for editing.

You can make `enter` edit a command by putting `enter_accept = false` into your config file (~/.config/atuin/config.toml)
10 changes: 10 additions & 0 deletions src/content/docs/guide/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,13 @@ it, press tab.
You might like to configure an [inline
window](https://atuin.sh/docs/config/#inline_height), or [disable up arrow
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 <(curl --proto '=https' --tlsv1.2 -sSf https://setup.atuin.sh)
atuin import auto
```

Your shell history will be local only, not backed up, and not synchronized across devices.

0 comments on commit 6d9eb4d

Please sign in to comment.