ster doctor
Try every functionality Ster depends on, now, on this machine, and say for each that it works, or what failed and how to fix it, or why it was not tried.
Invocation and purpose#
ster doctor [--json]Run it when Ster misbehaves, before filing a report; support asks for its output first. The list is Ster's failure catalogue (ster errors list): every functionality with a command, a request or a screen that starts it is in the diagnosis exactly once. One that only reads is tried: the failure catalogue holds together, the telemetry directory can be written and where events go, the consent the user chose, the queue of waiting events, where support reports go and the replies to the ones filed from here, the workspace and its active pair set. One that changes your data or sends something is not tried, and the diagnosis says so: importing, selecting and removing a pair set, sending the waiting events, filing a report.
Ster Desktop's Help → Diagnose Ster… shows the same findings, read through ster request doctor, which completes with { "findings": [...], "status" } even when a functionality fails.
Inputs and options#
| Input | Required | Meaning |
|---|---|---|
--json | no | Print the findings as one JSON array instead of lines. |
WISENT_TELEMETRY_HOME, WISENT_TELEMETRY_COLLECTOR_URL, WISENT_SUPPORT_URL | no | The same directory and addresses ster telemetry and ster support use; the diagnosis tries what those commands would use. |
Output and state#
One line per functionality:
ok ster.telemetry: ~/.local/state/ster/telemetry can be written; events go to https://telemetry.wisent.com/api/analytics/mobile/collect
failed ster.workspace.active: reading the active pair set: no pair set is active; fix: ster workspace import <file>
skipped ster.workspace.remove: it removes a pair set from the workspaceWith --json, an array of { "operation", "state" } where state is works with observed, fails with failure_point, error_code, detail and remedy, or skipped with why. The diagnosis writes and removes one probe file in the telemetry directory and changes nothing else. It exits 0 when nothing failed and 1 when a functionality failed.
Refusals#
ster doctor refuses nothing of its own: every failure it meets is a finding, with the sentence and the fix the functionality itself declares (ster errors show <functionality>), and the other functionalities are still tried.