docs: abra.yml
All checks were successful
continuous-integration/drone/push Build is passing

See toolshed/abra#622
This commit is contained in:
2025-08-28 12:00:49 +02:00
parent 9d992aaf84
commit da3200cab6

View File

@ -94,6 +94,26 @@ git commit
make link
```
## Configure `abra` with `abra.yml`
There are few configuration options supported at this time but more can be added. We are open to requests!
### `$ABRA_DIR`
The lookup logic is defined like so.
* lookup $ABRA_DIR env
* look for config file and take value from there
* $HOME/.abra as fallback
If you create an `abra.yml` file in your `$PWD` with the following contents.
```
abraDir: .
```
Then `$ABRA_DIR` will be automatically picked up as `$PWD`. This is useful when you maintain multiple project configurations and recipes in various state of chaos and would like to separate those. `abra` will create all the usual `$HOME/.abra` state (`servers`/`recipes`/etc.) under your chosen `abraDir` value. This allows you to have multiple independent versions of specific recipes which are relevant for specific projects vs. relying on a single `$ABRA_DIR/recipes/<recipe>` and constantly having to switch between different chaotic hacks.
## Running abra server side
If you're on an environment where it's hard to run Docker, or command-line programs in general, you might want to install `abra` on a server instead of your local work station.