aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f47e1ff4..36065018 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -13,10 +13,12 @@ Before working on anything, we suggest taking a copy of your Atuin data director
While data directory backups are always a good idea, you can instruct Atuin to use custom path using the following environment variables:
```shell
-export ATUIN_RECORD_STORE_PATH=/tmp/atuin_records.db
-export ATUIN_DB_PATH=/tmp/atuin_dev.db
-export ATUIN_KV__DB_PATH=/tmp/atuin_kv.db
-export ATUIN_SCRIPTS__DB_PATH=/tmp/atuin_scripts.db
+export ATUIN_RECORD_STORE_PATH=/tmp/atuin_records.db # path to primary record store
+export ATUIN_DB_PATH=/tmp/atuin_dev.db # path to materialized history database
+export ATUIN_KV__DB_PATH=/tmp/atuin_kv.db # path to key-value store
+export ATUIN_SCRIPTS__DB_PATH=/tmp/atuin_scripts.db # path to scripts database
+export ATUIN_AI__DB_PATH=/tmp/atuin_ai_sessions.db # path to AI sessions database
+export ATUIN_META__DB_PATH=/tmp/atuin_meta.db # path to meta database
```
It is also recommended to update your `$PATH` so that the pre-exec scripts would use the locally built version: