summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEllie Huxtable <ellie@elliehuxtable.com>2022-10-12 22:49:01 +0100
committerEllie Huxtable <ellie@elliehuxtable.com>2022-10-12 22:49:01 +0100
commite85bd43b5953008deb3b5423d9026e24d4eae4d4 (patch)
treeb517c75b7e8727c0a1ee4c5144108ff3151ee711
parent621feb17a6ced5eb220dd768cd5ccafb091da0c3 (diff)
Document optionsserver-info
-rw-r--r--atuin-client/config.toml3
-rw-r--r--docs/config.md9
2 files changed, 12 insertions, 0 deletions
diff --git a/atuin-client/config.toml b/atuin-client/config.toml
index 0d82ac28..43b5e24c 100644
--- a/atuin-client/config.toml
+++ b/atuin-client/config.toml
@@ -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
diff --git a/docs/config.md b/docs/config.md
index 42d8b0bc..13aabac2 100644
--- a/docs/config.md
+++ b/docs/config.md
@@ -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`.