From b1f11851fbb7841c44a7cc8fba7496411cc8296f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= <joerg@thalheim.io>
Date: Fri, 25 Aug 2023 17:08:39 +0200
Subject: [PATCH] clan-cli: add README

---
 pkgs/clan-cli/README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 pkgs/clan-cli/README.md

diff --git a/pkgs/clan-cli/README.md b/pkgs/clan-cli/README.md
new file mode 100644
index 000000000..538916486
--- /dev/null
+++ b/pkgs/clan-cli/README.md
@@ -0,0 +1,29 @@
+# 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](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
+```
+
+## Hacking on the webui
+
+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.