Document options

This commit is contained in:
Ellie Huxtable 2022-10-12 22:49:01 +01:00
parent 621feb17a6
commit e85bd43b59
2 changed files with 12 additions and 0 deletions

View File

@ -15,6 +15,9 @@
## enable or disable automatic sync
# auto_sync = true
## enable or disable automatic update checks
# update_check = true
## how often to sync history. note that this is only triggered when a command
## is ran, so sync intervals may well be longer
## set it to 0 to sync after every command

View File

@ -47,6 +47,15 @@ true
auto_sync = true/false
```
### `update_check`
Configures whether or not to automatically check for updates. Defaults to
true.
```
auto_sync = true/false
```
### `sync_address`
The address of the server to sync with! Defaults to `https://api.atuin.sh`.