Initial workspace launcher

doc/usage.md

@@ -0,0 +1,128 @@
+# Uzycie CLI
+
+Plik opisuje przelaczniki i liste komend skryptu `workspace.py`.
+
+## Wywolanie glowne
+
+```bash
+python3 workspace.py [--config PATH] <komenda> [opcje]
+```
+
+Globalne przelaczniki:
+
+- `--config PATH`
+  Uzywa innego pliku `workspace.json`.
+
+Komendy:
+
+- `show-config`
+- `list-series`
+- `list-cards [series]`
+- `tmux-container [series] [card]`
+
+## `show-config`
+
+Wypisuje rozwiazane sciezki z konfiguracji.
+
+Typowy format:
+
+```text
+config_path<TAB>...
+workspace_root<TAB>...
+series_root<TAB>...
+socket_root<TAB>...
+tools_root<TAB>...
+tools_root_candidates
+  ...
+```
+
+Przyklad:
+
+```bash
+python3 workspace.py show-config
+```
+
+## `list-series`
+
+Listuje katalogi serii znalezione w `series_root`.
+
+Kazda linia ma format:
+
+```text
+<series_id><TAB><liczba_kart><TAB><pelna_sciezka>
+```
+
+Przyklad:
+
+```bash
+python3 workspace.py list-series
+```
+
+## `list-cards [series]`
+
+Listuje karty z wybranej serii.
+
+Argumenty:
+
+- `series`
+  Opcjonalne id serii, na przyklad `inf`.
+  Jesli go brak, brana jest domyslna seria z `workspace.json`.
+
+Format wyjscia:
+
+```text
+<card_no><TAB><tytul_z_README><TAB><pelna_sciezka>
+```
+
+Jesli `README.md` nie ma naglowka `#`, skrypt wypisuje:
+
+```text
+<card_no><TAB><pelna_sciezka>
+```
+
+Przyklady:
+
+```bash
+python3 workspace.py list-cards
+python3 workspace.py list-cards inf
+```
+
+## `tmux-container [series] [card]`
+
+Tworzy nowa sesje `tmux` i uruchamia kontener w `pane 0`.
+
+Argumenty pozycyjne:
+
+- `series`
+  Id serii albo pelny selector, na przyklad `inf` albo `inf/03`.
+- `card`
+  Numer karty, na przyklad `03`.
+
+Przelaczniki:
+
+- `--session NAME`
+  Nadpisuje nazwe sesji `tmux`.
+- `--window NAME`
+  Nadpisuje nazwe okna `tmux`.
+- `--instance NAME`
+  Ustawia `RV_INSTANCE` dla wrappera `rv`.
+- `--attach`
+  Po utworzeniu sesji robi `tmux attach`.
+- `--dry-run`
+  Nie uruchamia `tmux`; wypisuje selector, sciezki i koncowa komende.
+
+Reguly wyboru karty:
+
+- `tmux-container inf 03` -> seria `inf`, karta `03`
+- `tmux-container inf/03` -> pelny selector
+- `tmux-container 03` -> domyslna seria + karta `03`
+- `tmux-container inf` -> seria `inf` + domyslna karta
+- bez argumentow -> domyslna seria i domyslna karta
+
+Przyklady:
+
+```bash
+python3 workspace.py tmux-container 03 --dry-run
+python3 workspace.py tmux-container inf 03 --session rv-inf03
+python3 workspace.py tmux-container inf/03 --attach
+```