From 910b11947e0302ec16c3e19a9f93e125d341e4a0 Mon Sep 17 00:00:00 2001 From: David Perl Date: Tue, 14 Jul 2026 14:34:45 +0200 Subject: [PATCH] docs: update readme --- README.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ccb6956..025b826 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ CLI/TUI launcher for the AareDAQ server and GUI on MX beamline consoles at PSI. Installed as the `aarel` command. It detects the current beamline and launches the -matching application, or opens a TUI to pick one. +matching application, opens a TUI to pick one, or deploys a new checkout. ## Usage @@ -15,7 +15,32 @@ matching application, or opens a TUI to pick one. aarel pick # open the TUI to choose what to launch aarel gui # launch the GUI for the detected beamline aarel server # launch the server for the detected beamline +aarel deploy # clone the repos and install them into a new virtualenv ``` -Use `--entry ` with `gui`/`server` to override detection, and `--config -` to use a different config file. +Each command has a single-letter alias (`p`, `g`, `s`, `d`). `--config ` +selects a different config file; it defaults to `data/defaults.json`. + +### Launching + +`gui` and `server` pick their config entry from the detected beamline. Use +`--entry ` to launch a different one. + +### Deploying + +`deploy ` clones [aaredaq] and [aarecommon] into `/`, then +installs both editable into a fresh `uv` virtualenv at `/`. It +requires `git` and `uv` on the `PATH`. + +| Flag | Effect | +| --- | --- | +| `--upgrade` | Update an existing deployment (`git pull` + reinstall) instead of refusing to overwrite it. | +| `--force` | Deploy a production name from a machine on another beamline. | + +The production names `x06da`, `x06sa` and `x10sa` may only be deployed from their +own beamline's machines. Any other name is a test or development deployment and +can be deployed anywhere. This is a guard against mistakes, not a security +boundary, and `--force` bypasses it. + +[aaredaq]: https://gitea.psi.ch/mx/aaredaq +[aarecommon]: https://gitea.psi.ch/mx/aarecommon