Skip to content

Fix punctuation and grammar in basic usage guide #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
waldyrious wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix punctuation and grammar in basic usage guide #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions src/content/docs/guide/basic-usage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
title: "Basic Usage"
---

Now that you're all setup and running, here's a quick walkthrough of how you can use Atuin best
Now that you're all setup and running, here's a quick walkthrough of how you can use Atuin best.

## What does Atuin record?

While you work, Atuin records
While you work, Atuin records:

1. The command you run
2. The directory you ran it in
Expand All @@ -17,11 +17,11 @@ While you work, Atuin records

## Opening and using the TUI

At any time, you can open the TUI with the default keybindings of the up arrow, or control-R.
At any time, you can open the TUI with the default keybindings of the up arrow, or ctrl-r.

Once in the TUI, press enter to immediately execute a command, or press tab to insert it into your shell for editing.

While searching in the TUI, you can adjust the "filter mode" by repeatedly pressing ctrl-r. Atuin can filter by
While searching in the TUI, you can adjust the "filter mode" by repeatedly pressing ctrl-r. Atuin can filter by:

1. All hosts
2. Just your local machine
Expand All @@ -30,15 +30,14 @@ While searching in the TUI, you can adjust the "filter mode" by repeatedly press

## Common config adjustment

For a full set of config values, please see the [config reference page](/configuration/config/)
For a full set of config values, please see the [config reference page](/configuration/config/).

The default configuration file is location at `~/.config/atuin/config.toml`
The default configuration file is located at `~/.config/atuin/config.toml`.

### Keybindings

We have a full page dedicated to keybinding adjustments, there are a whole bunch of options here! Including disabling the up arrow if you don't like it.

Read more [here](/configuration/key-binding/)
We have a [full page dedicated to keybinding adjustments](/configuration/key-binding/).
There are a whole bunch of options there, including disabling the up arrow behavior if you don't like it.

### Enter to run

Expand All @@ -52,14 +51,14 @@ in your config file.

### Inline window

If you find the full screen TUI overwhelming or too much, you can adjust it like so
If you find the full screen TUI overwhelming or too large, you can adjust it like so:

```
# height of the search window
inline_height = 40
```

You may also prefer the compact UI mode
You may also prefer the compact UI mode:

```
style = "compact"
Expand Down