Skip to content

Suggested searches

    Search all documentation ↑↓ to navigate Enter to open Esc to close

    Device Agent Commands

    Reference every probo-agent CLI command, including install, uninstall, run, status, collect, and update, along with their flags and expected output.

    Markdown

    probo-agent is the CLI for installing, running, inspecting, and updating the device posture agent.

    Global flag:

    FlagDescription
    -d, --dirAgent config / keystore directory (defaults to the platform-specific path)

    Enroll this device and install the agent as a managed OS service.

    Terminal window
    sudo probo-agent install \
    --server https://us.probo.com \
    --enrollment-token YOUR_TOKEN
    FlagDescription
    --serverProbo server base URL (required)
    --enrollment-tokenOne-shot enrollment token (or PROBO_ENROLLMENT_TOKEN)
    --skip-serviceRegister the device but skip OS service installation
    --no-auto-updatePersist updates_disabled in config and skip automatic upgrades

    On success the command prints the configured device ID plus heartbeat and posture intervals.

    Stop the service, unenroll the device from Probo, remove tray auto-start when present, and delete local state.

    Terminal window
    sudo probo-agent uninstall

    On macOS, uninstall requires root (sudo).

    Run the agent loop in the foreground. Useful for debugging; production installs normally run under the OS service supervisor.

    Terminal window
    probo-agent run

    Print the agent’s local state.

    Terminal window
    probo-agent status

    Example fields:

    • Server URL
    • Device ID
    • Heartbeat interval
    • Posture interval
    • Update interval
    • Auto-update enabled
    • Whether an API key is present on disk
    • Config directory

    Run the posture check set once and print results without pushing them to the server.

    Terminal window
    probo-agent collect
    probo-agent collect --json
    FlagDescription
    --jsonEmit JSON instead of the table
    --print-dirPrint the resolved agent directory before results
    --onceRun once and exit (default true)

    Check GitHub Releases for a newer probo-agent/v* tag and install it in place. Releases are verified with Cosign/Sigstore before the binary is replaced.

    Terminal window
    probo-agent update
    probo-agent update --check
    FlagDescription
    --checkReport whether an update is available without installing it

    After a successful update, restart the OS service (or let the supervisor restart after the agent exits with the dedicated restart code).

    • macOS: install the signed .pkg, then enroll from the Probo console via Probo Agent.app / probo:// deeplink. See macOS.
    • Windows: install the signed .msi, then enroll from the Probo console via the tray. See Windows.
    • Linux: enroll with install.sh or probo-agent install. See Linux.
    • FreeBSD: enroll with install.sh or probo-agent install. See FreeBSD.