History

Jörg Thalheim 4735586dac All checks were successful checks / test (pull_request) Successful in 19s Details checks-impure / test (pull_request) Successful in 3s Details fix uneccessary clan-cli rebuilds by not relying on self		2023-08-27 10:21:02 +02:00
..
bin	generate openapi	2023-08-25 11:39:46 +02:00
clan_cli	checks-integration: init	2023-08-27 00:24:19 +02:00
tests	tests: rewrite port allocation function	2023-08-27 09:34:36 +02:00
.envrc	rename clan to clan-cli	2023-08-08 14:18:10 +02:00
default.nix	fix uneccessary clan-cli rebuilds by not relying on self	2023-08-27 10:21:02 +02:00
flake-module.nix	fix uneccessary clan-cli rebuilds by not relying on self	2023-08-27 10:21:02 +02:00
pyproject.toml	run pytest in parallel	2023-08-27 09:45:15 +02:00
README.md	clan-cli: add README	2023-08-26 12:38:11 +02:00
shell.nix	fix uneccessary clan-cli rebuilds by not relying on self	2023-08-27 10:21:02 +02:00

clan-cli

The clan-cli contains the command line interface as well as the graphical webui through the clan webui command.

Hacking on the cli

We recommend setting up direnv 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

By default the webui is build from a tarball available https://git.clan.lol/clan/-/packages/generic/ui/. To start a local developement environment instead, use the --dev flag:

./bin/clan webui --dev

This will spawn two webserver, a python one to for the api and a nodejs one that rebuilds the ui on the fly.