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
This commit is contained in:
2025-05-28 14:24:54 +02:00
parent 113103f368
commit fb2a62d984
2 changed files with 22 additions and 15 deletions

View File

@@ -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/`) - Unterstützt `--user` Timer (für `~/.config/systemd/user/`)
- Optionales Logging (`StandardOutput/StandardError`) - Optionales Logging (`StandardOutput/StandardError`)
- Unterstützt: - Unterstützt:
- `--calendar` - `--calendar`: Zeitplan für den Timer (systemd `OnCalendar`)
- `--exec` - `--exec`: Auszuführendes Kommando (`ExecStart`)
- `--after` - `--description`: Beschreibung für die Unit
- `--environment` - `--after`: `After=`-Abhängigkeiten in der Service-Unit
- `--output` - `--environment`: Beliebige `Environment=KEY=VALUE` Einträge
- `--dry-run` - `--output`: Zielverzeichnis für die generierten Unit-Dateien
- Getestet und typisiert mit Deno + Cliffy - `--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**
--- ---

View File

@@ -13,14 +13,17 @@ A simple CLI tool for quickly generating systemd `.service` and `.timer` units
* Supports `--user` timers (for `~/.config/systemd/user/`) * Supports `--user` timers (for `~/.config/systemd/user/`)
* Optional logging (`StandardOutput/StandardError`) * Optional logging (`StandardOutput/StandardError`)
* Supports: * Supports:
* `--calendar`: Timer schedule (systemd `OnCalendar`)
* `--calendar` * `--exec`: Command to execute (`ExecStart`)
* `--exec` * `--description`: Description for the unit
* `--after` * `--after`: `After=` dependencies in the service unit
* `--environment` * `--environment`: Arbitrary `Environment=KEY=VALUE` entries
* `--output` * `--output`: Target directory for the generated unit files
* `--dry-run` * `--run-as`: Sets `User=` in the service unit (only for system-level timers)
* Tested and typed with Deno + Cliffy * `--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**
--- ---