atuin/docs/config.md
Ellie Huxtable 156893d774
Update docs, unify on SQLx, bugfixes (#40)
* Begin moving to sqlx for local too

* Stupid scanners should just have a nice cup of tea

Random internet shit searching for /.env or whatever

* Remove diesel and rusqlite fully
2021-04-25 17:21:52 +00:00

1.8 KiB

Config

Atuin maintains two configuration files, stored in ~/.config/atuin/. We store data in ~/.local/share/atuin (unless overridden by XDG_*).

You can also change the path to the configuration directory by setting ATUIN_CONFIG_DIR. For example

export ATUIN_CONFIG_DIR = /home/ellie/.atuin

Client config

~/.config/atuin/config.toml

The client runs on a user's machine, and unless you're running a server, this is what you care about.

See config.toml for an example

dialect

This configures how the stats command parses dates. It has two possible values

dialect = "uk"

or

dialect = "us"

and defaults to "us".

auto_sync

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

auto_sync = true/false

sync_address

The address of the server to sync with! Defaults to https://api.atuin.sh.

sync_address = "https://api.atuin.sh"

sync_frequency

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

If set to 0, Atuin will sync after every command. Some servers may potentially rate limit, which won't cause any issues.

sync_frequency = "1h"

db_path

The path to the Atuin SQlite database. Defaults to ~/.local/share/atuin/history.db.

db_path = "~/.history.db"

key_path

The path to the Atuin encryption key. Defaults to ~/.local/share/atuin/key.

key = "~/.atuin-key"

session_path

The path to the Atuin server session file. Defaults to ~/.local/share/atuin/session. This is essentially just an API token

key = "~/.atuin-session"

Server config

// TODO