Collector CLI

Applies to1.1.0DifficultyBeginner

The Collector installs a single command, oculis-collector. Day-to-day operation needs no commands at all — the Collector runs as a service and starts at boot — so this reference covers the few things you may want to check or change by hand.

For a container deployment, prefix each command with docker exec oculis-collector.

Check status

oculis-collector --status

Reports whether the Collector is running and connected to Oculis, and when it last delivered data. It reads local state only, so it works even when the host cannot reach Oculis — which is what makes it useful for diagnosing exactly that.

Exit codes: 0 when the Collector is running, 1 when it is stopped or unhealthy. That makes it usable directly in a monitoring check.

Option	Effect
--json	Machine-readable output instead of the human-readable report
--watch N	Re-render the report every N seconds until interrupted

oculis-collector --status --json

Check the installed version

oculis-collector --version

Add --json for machine-readable output. Use this to confirm which release a host is running before reporting a problem.

Remove the Collector

oculis-collector --uninstall

Stops the Collector and removes it from the host. Collector state is preserved by default, so reinstalling keeps the same Collector rather than enrolling a new one.

Option	Effect
--purge-all	Also remove stored state and logs
--yes	Do not prompt for confirmation

Purging state changes the Collector's identity

--purge-all discards the stored state that identifies this Collector to Oculis. A later reinstall registers as a new Collector. Use it when you are decommissioning a host, not when you are upgrading one.

Logging

The Collector logs through your platform’s normal service logging. View them with the tool you already use:

Linux

journalctl -u oculis-collector

macOS

Open Console and select the oculis-collector process.

Windows

Open Event Viewer and select the OculisCollector service.

Docker

docker logs oculis-collector

To raise verbosity while reproducing a problem, set the log level to DEBUG and restart the service. Return it to INFO afterwards — DEBUG is considerably more verbose and is not intended for continuous use.

Versions

This page describes Oculis Collector 1.1.0. Run oculis-collector --version to confirm what a host has installed.