Initial mm CLI

README.md

@@ -0,0 +1,34 @@
+# mm
+
+`mm` is a local terminal dashboard for GPU status on SSH machines.
+
+## Install
+
+```bash
+python3 -m pip install -e .
+```
+
+## Configure
+
+Create either `./.config/mm/list.yaml` in the directory where you run `mm`, or
+`~/.config/mm/list.yaml` for a global config.
+
+```yaml
+machines:
+  - dash0
+  - dash1
+  - dash2
+  - alias: dash3
+    label: dash3 / lab
+```
+
+Each alias must be reachable by `ssh <alias>` and must have `nvidia-smi`
+available on the remote machine.
+
+## Run
+
+```bash
+mm
+mm --config ~/.config/mm/list.yaml
+mm --timeout 8
+```