> For the complete documentation index, see [llms.txt](https://help.aikido.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.aikido.dev/aikido-device-protection/miscellaneous-aikido-endpoint/aikidoctl-cli.md). # 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 {% tabs %} {% tab title="macOS" %} ``` aikidoctl [global options] command [command options] ``` {% endtab %} {% tab title="Windows" %} ``` aikidoctl.exe [global options] command [command options] ``` {% endtab %} {% tab title="Linux" %} ``` aikidoctl [global options] command [command options] ``` {% endtab %} {% endtabs %} Run `aikidoctl help` (or `aikidoctl --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. | Command | Not available on | Description | | ----------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `certs` | Windows, Linux | Manage CA certificates. | | `certconfig` | | Manage per-tool certificate trust configuration (node, git, java, etc.). | | `pause` | | Pause Aikido Device Protection for a specified duration. **This fully disables all protection on the device while paused.** | | `unpause` | | Resume Aikido Device Protection if it is currently paused. | | `sbom` | Linux | Inspect the software bill of materials (SBOM) collection. | | `secretscanning` | Windows, Linux | Inspect on-device secret scanning. | | `device-identity` | macOS, Linux | Show 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](#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.

| | `request` | | List packages blocked pending admin approval, and send that request with `aikidoctl request`. See [Request a Blocked Install from the Command Line](/aikido-device-protection/miscellaneous-aikido-endpoint/aikidoctl-cli/request-a-blocked-install.md). | | `restart-daemon` | Linux | Restart the Aikido Device Protection daemon. | | `version` | | Show the installed Device Protection version, build details, and service state. | | `help`, `h` | | Show 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](/aikido-device-protection/miscellaneous-aikido-endpoint/custom-ca-certificates.md). ## 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](https://app.aikido.dev/endpoint-protection/devices) 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: {% code overflow="wrap" %} ```powershell aikidoctl.exe device-identity reset ``` {% endcode %} 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 | Option | Description | | ----------------- | ---------------------------------------------------------------- | | `--simple` | Print only the installed Device Protection version, for scripts. | | `--help`, `-h` | Show help. | | `--version`, `-v` | Print the version. | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://help.aikido.dev/aikido-device-protection/miscellaneous-aikido-endpoint/aikidoctl-cli.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.