aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMichelle Tilley <michelle@michelletilley.net>2025-05-13 08:29:04 -0700
committerGitHub <noreply@github.com>2025-05-13 08:29:04 -0700
commitc93991b5d0e76b7c2381f840655620cfdc2b8388 (patch)
treecbc68cedb9e8e2cf3c749e4aa1d732c272008aaa /CONTRIBUTING.md
parentchore(deps): bump tower from 0.4.13 to 0.5.2 (#2734) (diff)
downloadatuin-c93991b5d0e76b7c2381f840655620cfdc2b8388.zip
chore: Allow setting script DB path (#2750)
* chore: Allow setting script DB path * Rename scripts.database_path setting to scripts.db_path to match other crates
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0a761e07..8f5b2194 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -13,9 +13,10 @@ 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_RECORD_STORE_PATH=/tmp/atuin_records.db
+export ATUIN_SCRIPTS__DB_PATH=/tmp/atuin_scripts.db
```
It is also recommended to update your `$PATH` so that the pre-exec scripts would use the locally built version:
@@ -24,7 +25,7 @@ It is also recommended to update your `$PATH` so that the pre-exec scripts would
export PATH="./target/release:$PATH"
```
-These 4 variables can be added in a local `.envrc` file, read by [direnv](https://direnv.net/).
+These 5 variables can be added in a local `.envrc` file, read by [direnv](https://direnv.net/).
## PRs