Skip to content
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.

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

docs(config): clarify scope of directory filter_mode #67

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
30 changes: 15 additions & 15 deletions src/content/docs/configuration/config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ The full path to the config file would be `~/.config/atuin/config.toml`
The config location can be overridden with ATUIN_CONFIG_DIR

### `db_path`
Default: `~/.local/share/atuin/history.db`
Default: `~/.local/share/atuin/history.db`

The path to the Atuin SQLite database.
The path to the Atuin SQLite database.

```toml
db_path = "~/.history.db"
Expand All @@ -30,15 +30,15 @@ key_path = "~/.atuin-key"
### `session_path`
Default: `~/.local/share/atuin/session`

The path to the Atuin server session file.
The path to the Atuin server session file.
This is essentially just an API token

```toml
session_path = "~/.atuin-session"
```

### `dialect`
Default: `us`
Default: `us`

This configures how the [stats](/reference/stats/) command parses dates. It has two
possible values
Expand All @@ -54,9 +54,9 @@ dialect = "us"
```

### `auto_sync`
Default: `true`
Default: `true`

Configures whether or not to automatically sync, when logged in.
Configures whether or not to automatically sync, when logged in.

```toml
auto_sync = true/false
Expand All @@ -65,7 +65,7 @@ auto_sync = true/false
### `update_check`
Default: `true`

Configures whether or not to automatically check for updates.
Configures whether or not to automatically check for updates.

```toml
update_check = true/false
Expand All @@ -74,7 +74,7 @@ update_check = true/false
### `sync_address`
Default: `https://api.atuin.sh`

The address of the server to sync with!
The address of the server to sync with!

```toml
sync_address = "https://api.atuin.sh"
Expand All @@ -84,7 +84,7 @@ sync_address = "https://api.atuin.sh"
Default: `1h`

How often to automatically sync with the server. This can be given in a
"human-readable" format. For example, `10s`, `20m`, `1h`, etc.
"human-readable" format. For example, `10s`, `20m`, `1h`, etc.

If set to `0`, Atuin will sync after every command. Some servers may potentially
rate limit, which won't cause any issues.
Expand Down Expand Up @@ -136,7 +136,7 @@ The default filter to use when searching
| global (default) | Search history from all hosts, all sessions, all directories |
| host | Search history just from this host |
| session | Search history just from the current session |
| directory | Search history just from the current directory |
| directory | Search history just from the current directory (global) |

Filter modes can still be toggled via ctrl-r

Expand Down Expand Up @@ -178,7 +178,7 @@ Atuin version: >= 17.0
Default: `false`

This flag enables a pseudo filter-mode named "workspace": the filter is automatically
activated when you are in a git repository.
activated when you are in a git repository.

With workspace filtering enabled, Atuin will filter for commands executed in any directory
within a git repository tree.
Expand All @@ -205,7 +205,7 @@ Atuin version: >= 17.0

Default: `false`

Invert the UI - put the search bar at the top.
Invert the UI - put the search bar at the top.

```toml
invert = true/false
Expand Down Expand Up @@ -253,7 +253,7 @@ Default: `true`
Configure whether or not to show tabs for search and inspect.

### `exit_mode`
Default: `return-original`
Default: `return-original`

What to do when the escape key is pressed when searching

Expand Down Expand Up @@ -444,7 +444,7 @@ common_prefix = [...]
```

### `common_subcommands`
Default:
Default:

```toml
common_subcommands = [
Expand Down Expand Up @@ -596,7 +596,7 @@ sync_frequency = 300
```

### socket_path
Default:
Default:
```toml
socket_path = "~/.local/share/atuin/atuin.sock"
```
Expand Down