English

The aikidoctl CLI

aikidoctl is a command-line help tool that ships with Aikido Device Protection. It provides utilities to inspect, control, and troubleshoot the agent when something goes wrong.

Usage

aikidoctl [global options] command [command options]

Run aikidoctl help (or aikidoctl <command> --help) at any time to list the available commands and options. On Windows, use aikidoctl.exe.

Commands

Not every command is available on every platform. The Not available on column lists where a command is missing. An empty cell means it works everywhere.

CommandNot available onDescription
certsWindows, LinuxManage CA certificates.
certconfigManage per-tool certificate trust configuration (node, git, java, etc.).
pausePause Aikido Device Protection for a specified duration. This fully disables all protection on the device while paused.
unpauseResume Aikido Device Protection if it is currently paused.
sbomLinuxInspect the software bill of materials (SBOM) collection.
secretscanningWindows, LinuxInspect on-device secret scanning.
device-identitymacOS, LinuxShow or reset the identity the device registers with. Run device-identity reset on a machine created from a VM clone or snapshot. See Cloned VMs and images.
diagnostics

Collect and submit diagnostics to Aikido.

The diagnostics command is the command-line equivalent of the in-app Report A Problem flow. See Report a Problem / Device Protection Support for when and how to send diagnostics to Aikido.

requestList packages blocked pending admin approval, and send that request with aikidoctl request. See Request a Blocked Install from the Command Line.
restart-daemonLinuxRestart the Aikido Device Protection daemon.
versionShow the installed Device Protection version, build details, and service state.
help, hShow a list of commands or help for one command.

To add your organization's own CA to the certificate bundles Aikido builds, see Adding a Custom CA Certificate.

Cloned VMs and images

A device's identity is created when the agent first registers. If you install Device Protection on a VM and then clone or snapshot that VM, every machine created from it carries the same identity, so they all collapse into a single entry in your device list and you lose visibility on all but one.

On Windows, after deploying a clone or snapshot:

  1. Give the machine its own hostname.
  2. Reset the device identity:
aikidoctl.exe device-identity reset

The machine then registers as its own device on the next check-in. Remove the stale shared entry from your device list if one is already there.

On Linux, device identity follows /etc/machine-id instead. Truncate that file as the last step of your image build so each machine generates its own ID on first boot.

Global options

OptionDescription
--simplePrint only the installed Device Protection version, for scripts.
--help, -hShow help.
--version, -vPrint the version.