From fb2a62d984615caa4035fd5c1e8e64d245499e47 Mon Sep 17 00:00:00 2001 From: "Max P." Date: Wed, 28 May 2025 14:24:54 +0200 Subject: [PATCH] docs(readme): expand CLI option descriptions for clarity - Add detailed explanations for each CLI option in README files - Improve consistency and formatting for better readability - Highlight supported features and usage comprehensively --- README.DE.md | 18 +++++++++++------- README.md | 19 +++++++++++-------- 2 files changed, 22 insertions(+), 15 deletions(-) diff --git a/README.DE.md b/README.DE.md index d40546a..43576bd 100644 --- a/README.DE.md +++ b/README.DE.md @@ -12,13 +12,17 @@ Ein einfaches CLI-Tool zum schnellen Erzeugen von systemd `.service` und `.timer - Unterstützt `--user` Timer (für `~/.config/systemd/user/`) - Optionales Logging (`StandardOutput/StandardError`) - Unterstützt: - - `--calendar` - - `--exec` - - `--after` - - `--environment` - - `--output` - - `--dry-run` -- Getestet und typisiert mit Deno + Cliffy + - `--calendar`: Zeitplan für den Timer (systemd `OnCalendar`) + - `--exec`: Auszuführendes Kommando (`ExecStart`) + - `--description`: Beschreibung für die Unit + - `--after`: `After=`-Abhängigkeiten in der Service-Unit + - `--environment`: Beliebige `Environment=KEY=VALUE` Einträge + - `--output`: Zielverzeichnis für die generierten Unit-Dateien + - `--run-as`: Setzt `User=` in der Service-Unit (nur systemweite Timer) + - `--home`: Setzt `Environment=HOME=…` + - `--cwd`: Arbeitsverzeichnis des Prozesses (`WorkingDirectory`) + - `--dry-run`: Gibt nur die generierten Inhalte aus, ohne sie zu schreiben +- Getestet und typisiert mit **Deno** + **Cliffy** --- diff --git a/README.md b/README.md index 45639ac..b669418 100644 --- a/README.md +++ b/README.md @@ -13,14 +13,17 @@ A simple CLI tool for quickly generating systemd `.service` and `.timer` units * Supports `--user` timers (for `~/.config/systemd/user/`) * Optional logging (`StandardOutput/StandardError`) * Supports: - - * `--calendar` - * `--exec` - * `--after` - * `--environment` - * `--output` - * `--dry-run` -* Tested and typed with Deno + Cliffy + * `--calendar`: Timer schedule (systemd `OnCalendar`) + * `--exec`: Command to execute (`ExecStart`) + * `--description`: Description for the unit + * `--after`: `After=` dependencies in the service unit + * `--environment`: Arbitrary `Environment=KEY=VALUE` entries + * `--output`: Target directory for the generated unit files + * `--run-as`: Sets `User=` in the service unit (only for system-level timers) + * `--home`: Sets `Environment=HOME=…` + * `--cwd`: Working directory for the process (`WorkingDirectory`) + * `--dry-run`: Outputs unit content without writing to disk +* Tested and fully typed with **Deno** + **Cliffy** ---