From 6d9eb4d3c93ace448a1c78609e233aa5d36827d0 Mon Sep 17 00:00:00 2001 From: Ellie Huxtable Date: Fri, 12 Jan 2024 15:42:06 +0000 Subject: [PATCH] docs: add faq, offline install --- astro.config.mjs | 1 + src/content/docs/faq.mdx | 23 ++++++++++++++++++++++ src/content/docs/guide/getting-started.mdx | 10 ++++++++++ 3 files changed, 34 insertions(+) create mode 100644 src/content/docs/faq.mdx diff --git a/astro.config.mjs b/astro.config.mjs index 1299299..ec94eb7 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -64,6 +64,7 @@ export default defineConfig({ }, { label: 'Known issues', link: '/known-issues' }, { label: 'Integrations', link: '/integrations' }, + { label: 'FAQ', link: '/faq' }, ], }), ], diff --git a/src/content/docs/faq.mdx b/src/content/docs/faq.mdx new file mode 100644 index 0000000..eb8eb49 --- /dev/null +++ b/src/content/docs/faq.mdx @@ -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) diff --git a/src/content/docs/guide/getting-started.mdx b/src/content/docs/guide/getting-started.mdx index 6a3f91f..b4ec3f4 100644 --- a/src/content/docs/guide/getting-started.mdx +++ b/src/content/docs/guide/getting-started.mdx @@ -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.