chore: publish pxmon v0.2.0

docs/COMMANDS.md

@@ -0,0 +1,119 @@
+# Command Reference
+
+## Root
+- `pxmon [--config path] [--json] <command>`
+- `pxmon help`
+- `pxmon shell` (interactive alias to TUI)
+- `pxmon tui [name-or-id] [--interval 2s] [--iface eth0]`
+- `pxmon clusters [name-or-id] [--interval 2s] [--iface eth0]`
+- `pxmon network [name-or-id] [--interval 2s] [--iface eth0]`
+- `pxmon cluster ...`
+- `pxmon bot ...`
+- `pxmon locker ...`
+- `pxmon config ...`
+- `pxmon export ...` (shortcut)
+- `pxmon import ...` (shortcut)
+- `pxmon explain [--find text]`
+
+## Cluster command tree
+- `connect|add`
+- `list|ls`
+- `show|get`
+- `current`
+- `use`
+- `disconnect|remove|rm`
+- `set-auth|auth|password|passwd`
+- `openssh|ssh`
+- `exec|run <name-or-id> -- <command>`
+- `ping|check`
+- `bootstrap`
+- `agent`
+  - `status [name-or-id]`
+  - `adopt-auth|sync-auth|repair-auth [name-or-id]`
+  - `update [name-or-id] [--restart-bot=true|false]`
+  - `versions|version-list`
+- `stats [name-or-id] [--once]`
+- `usage [name-or-id] --range live|1h|1d|1mo|all [--du /]`
+- `traffic [name-or-id] --range 1h|1d|1mo|all`
+- `graph [name-or-id] --range 1h|1d|1mo|all [--out file.png]`
+- `p95 [name-or-id] --iface <iface> --range <duration> [--graph]`
+- `slo|availability [name-or-id] --range 7d|30d|all`
+- `capacity forecast [name-or-id] --range 7d|30d|all`
+- `alert|alerts show|set [name-or-id]`
+- `alert-routing|routing show|set [name-or-id]`
+- `alert-vm|vm-alert show|set|check [name-or-id]`
+- `software|plugins show|scan [name-or-id]`
+- `tag|tags add|rm|ls [name-or-id] --tags a,b`
+- `kvm-tag|vm-tag add|rm|ls [name-or-id] --vm <name> --tags a,b`
+- `change-history|changes [--tail N]`
+- `drift [name-or-id]`
+  - `baseline set|show [name-or-id]`
+  - `ack [name-or-id] --kind <kind> --for 24h`
+- `report export --format json|csv --out <path>`
+- `backup`
+  - `target add|ls|rm|test`
+  - `plan add|ls|rm|run`
+  - `run <plan-id-or-name>`
+- `repo-tunnel|repo|repo-tunneling`
+  - `gateway-script --allow <ip-or-cidr> [--port 3128]`
+  - `gateway-setup <gateway-node> --allow <ip-or-cidr> [--port 3128]`
+  - `enable <name-or-id> --gateway <host:port> --table <id> [--gateway-ip <ip>] [--manager auto|apt|dnf|yum]`
+  - `install <name-or-id> --gateway <host:port> --table <id> -- <command>`
+  - `status <name-or-id>`
+  - `disable <name-or-id> --gateway <host:port> --table <id>`
+- `runbook`
+  - `list`
+  - `show <id>`
+  - `run <id>`
+  - `add --id ... --name ... --step ...`
+  - `add --edit`
+  - `add --from <path>`
+  - `rm <id>`
+- `runbook-trigger show|set [name-or-id]`
+- `schedule|scheduler`
+  - `add --name ... --cmd ... --every ...`
+  - `add --edit`
+  - `add --from <path>`
+  - `ls`
+  - `rm <task-id-or-name>`
+  - `run-due`
+  - `start [--interval 30s]`
+  - `stop`
+  - `status`
+  - `logs [--tail 200]`
+  - `worker [--interval 30s]`
+
+## Bot
+- `pxmon bot telegram show [--show-token]`
+- `pxmon bot telegram set --token <token> --allow <id> [--allow <id> ...]`
+- `pxmon bot telegram disable`
+- `pxmon bot telegram restart [--poll 2s]`
+- `pxmon bot telegram logs [--tail 200]`
+- `pxmon bot telegram run [--poll 2s]`
+
+## Locker
+- `pxmon locker status`
+- `pxmon locker set [--password <pw>]`
+- `pxmon locker unlock [--password <pw>]`
+- `pxmon locker lock`
+- `pxmon locker disable`
+- `pxmon locker logs [--tail 200]`
+
+## Config
+- `pxmon config export [<path>] [--out <path>] [--password <pw>]`
+- `pxmon config import <path> [--password <pw>] [--replace]`
+
+## In-TUI command console
+Alias examples:
+- `alerts ...` -> `cluster alert ...`
+- `connect <name>` -> `cluster use <name>`
+- `software ...` -> `cluster software ...`
+- `clusters` -> `cluster list`
+- `ping <name>` -> `cluster ping <name>`
+
+Plugin-style commands from console:
+- `kvm list|start|stop|reboot|top|net-top`
+- `lxc list|start|stop|restart|stats|top|net-top`
+- `lxd list|start|stop|restart|stats|top|net-top`
+- `bird status|protocols|routes`
+- `frr status|routes|bgp|ospf`