Document the desktop tray applet and check --json

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Luna 2026-07-03 07:40:06 -07:00
parent a5e954e0ed
commit 036469ed21
4 changed files with 49 additions and 1 deletions

View file

@ -35,11 +35,13 @@ Expected use: systemd, not an interactive shell.
```bash
enodia-sentinel check
enodia-sentinel check --json
```
Runs the enabled detector set once and prints alerts. This forces the SUID scan
and arms baseline-gated detectors immediately, so it is useful for health checks
and debugging.
and debugging. `--json` emits the alerts as a JSON array of alert dicts
(severity-ordered) instead of text, for scripts and the tray applet.
Exit code:
@ -381,6 +383,20 @@ text/status contrast pairs are covered by the web test suite.
Expected use: `enodia-sentinel-web.service`.
### `enodia-sentinel-tray`
```bash
enodia-sentinel-tray
```
Launches the optional desktop system-tray applet (no subcommands). It is a GUI
frontend over the commands above: the menu opens the dashboard (starting
`enodia-sentinel-web.service` if needed), starts/stops/restarts
`enodia-sentinel.service` via `systemctl`, shows daemon status and alert counts
from `status --json`, and runs `check --json` on demand with the result shown
as a desktop notification. Requires the `[tray]` extra (`pystray`, `Pillow`);
the core agent stays dependency-free without it.
### `triage`
```bash