janezicmatej
/
ahab
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: add completion and generation to readme

This commit is contained in:
Matej Janezic 2024-11-27 18:43:33 +01:00
parent e7308bd5c6
commit 63e9b772a7
Signed by: janezicmatej
GPG Key ID: 4298E230ED37B2C0
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,15 +1,25 @@
# ahab
## Installing
## installing
Clone this repo, with rust installed run this from root of the repo.
```
You will need rust installed. Clone repo and run:
```bash
cargo install --path .
```
For printing of underlying commands install with `debug` flag.
```
For printing of underlying commands build with `debug` flag.
```bash
cargo install --path . --debug
```
## shell completion
Completion files are generated *during build* process in `target/*/build/*/out/*`. Depending on your shell of choice move generated file to correct place in you file system.
## configuration
Currently `ahab` respects three environment variables.
- `COMPOSE_FILE`: control which docker-compose file is used - defaults to `docker/local/docker-compose.yaml`
- `AHAB_POSTGRES_CONATINER`: control which compose service is used for sending postgres commands - defaults to `postgresdb`
- `AHAB_POSTGRES_CONATINER`: control which compose service is used for sending django commands - defaults to `appserver`