clan-core/pkgs/clan-cli/README.md

48 lines
832 B
Markdown
Raw Normal View History

2023-08-25 15:08:39 +00:00
# clan-cli
2023-12-14 17:47:14 +00:00
The clan-cli contains the command line interface
2023-08-25 15:08:39 +00:00
## Hacking on the cli
We recommend setting up [direnv](https://direnv.net/) to load the developement with nix.
If you do not have it set up you can also use `nix develop` directly like this:
```
use flake .#clan-cli --builders ''
```
After you can use the local bin wrapper to test things in the cli:
```
./bin/clan
```
## Run locally single-threaded for debugging
By default tests run in parallel using pytest-parallel.
pytest-parallel however breaks `breakpoint()`. To disable it, use this:
2024-04-10 16:40:07 +00:00
```bash
2023-10-23 20:31:12 +00:00
pytest -n0 -s
```
You can also run a single test like this:
2024-04-10 16:40:07 +00:00
```bash
2023-10-23 20:31:12 +00:00
pytest -n0 -s tests/test_secrets_cli.py::test_users
```
2023-10-23 20:31:12 +00:00
## Run tests in nix container
Run all impure checks
2024-04-10 16:40:07 +00:00
```bash
nix run .#impure-checks
```
Run all checks
2024-04-10 16:40:07 +00:00
```bash
nix flake check
```