> ## Documentation Index > Fetch the complete documentation index at: https://support.i.moneyforward.com/llms.txt > Use this file to discover all available pages before exploring further. # Admina Tracker CLI command reference > Reference for the admina-tracker command-line interface. Learn about syntax, subcommands, config options, and diagnostics. The `admina-tracker` CLI tool manages agent lifecycle and checks operating status. It also diagnoses telemetry data. ## Running commands The method for running `admina-tracker` commands depends on your operating system and installation method: * **macOS**: `/usr/local/bin` is included in `PATH` by default, so you can run the command directly in Terminal. * **Windows**: * **Standalone installer**: `%LOCALAPPDATA%\AdminaTracker` is added to user `PATH` automatically. You can run `admina-tracker` directly in Command Prompt or PowerShell. * **Microsoft Intune**: `PATH` is not set automatically. Run the command using the full binary path: ```powershell theme={null} & "$env:LOCALAPPDATA\AdminaTracker\admina-tracker.exe" status ``` Command Prompt: ```cmd theme={null} "%LOCALAPPDATA%\AdminaTracker\admina-tracker.exe" status ``` Basic syntax: ```bash theme={null} admina-tracker [OPTIONS] ``` ### Common options | Option | Description | | - | - | | `-h`, `--help` | Show help information | | `--db-path ` | Specify database path (env: `ADMINA_TRACKER_DB_PATH`). Default path is used automatically | ## Lifecycle Commands to start, stop, restart, and update the agent. ### daemon Start the agent in the foreground. ```bash theme={null} admina-tracker daemon ``` ### stop Stop the running agent daemon. ```bash theme={null} admina-tracker stop ``` * **macOS**: Runs `launchctl bootout` to stop the LaunchAgent. * **Windows**: Stops the registered task or service, or terminates running user processes. ### restart Restart the agent daemon. ```bash theme={null} admina-tracker restart ``` * **macOS**: Reloads the LaunchAgent to restart the agent. * **Windows**: Stops and restarts the process via registered task or service mechanisms. ### update Check for agent updates. ```bash theme={null} # Check for available updates admina-tracker update # Apply update immediately if available admina-tracker update --apply ``` ### version Display agent version and build information. ```bash theme={null} admina-tracker version ``` ### enroll Manually trigger immediate enrollment with the server. ```bash theme={null} admina-tracker enroll ``` Useful when initial enrollment failed and you want to retry immediately without waiting for scheduled backoff retries. ## Configuration Commands to configure API connections and telemetry flags. ### configure Configure API connection settings. ```bash theme={null} admina-tracker configure [OPTIONS] ``` | Option | Description | | - | - | | `--api-key ` | Set API key | | `--organization-id ` | Set Organization ID | | `--serial-number ` | Manually set serial number | | `--user-email ` | Set user email address | ### config set Set telemetry collection and transmission flags. ```bash theme={null} admina-tracker config set ``` * ``: Target flag key (`telemetry_*`). Only recognized flags can be set. Credentials are set with `configure`. * ``: `true` or `false`. ## Diagnostics Commands to check operating status and view stored database records. ### status Show local diagnostic status. ```bash theme={null} admina-tracker status ``` Displays operational status, task settings, resolution chain, record counts, and log paths. Does not make network calls. The resolution chain lists every source consulted for `ApiKey`, `OrganizationID`, and `UserEmail`. The row actually in effect is marked with `**`, which tells you which delivery method a value came from. Two more items are shown alongside it. Hostname is the machine name as the OS reports it, used as the source PC in the event log. On macOS it is the kernel host name (the value of `sysctl kern.hostname`). On Windows it is the DNS host name. In both cases it matches what the `hostname` command prints. It does not read the `HOSTNAME` or `COMPUTERNAME` environment variables. It cannot be overridden through configuration. Proxy is shown as four rows: * `env var` — the environment variables * `OS setting` — the OS proxy configuration, read on Windows only * `effective` — the route actually used * `NO_PROXY` — the bypass list When a proxy URL carries credentials, the password is masked. ### diag Show local diagnostic status and run real-time server connectivity and authentication checks. ```bash theme={null} admina-tracker diag ``` While `status` is local-only, `diag` makes active network requests to verify: * DNS resolution, TCP connection, and TLS handshake to the API endpoint * Server authentication success and organization ID consistency using the resolved API key * Time synchronization status between the device and server (clock skew detection) Results appear in a `Checks` section. Each is marked `PASS`, `WARN`, `FAIL`, or `SKIP`, and the count of failures and warnings follows at the end. Any `FAIL` or `WARN` is followed by guidance on a line beginning with `->`. Clock skew is read from the server authentication response, so it is not checked when that authentication is `SKIP` or `FAIL`. `Connectivity` reports on whether the TLS handshake completed. A server that answers with an HTTP error still answered, so the handshake completed and the check reports `PASS`. PowerShell running admina-tracker.exe diag, with a Runtime section listing the agent version, API base URL, OS, hostname, daemon status, and scheduled task status ### config show Output stored configuration values (`api_key`, `organization_id`, `user_email`) in JSON format. ```bash theme={null} # Show configuration stored in local database admina-tracker config show # Show resolved configuration including policy settings and environment variables admina-tracker config show --resolved # Show the API key unmasked admina-tracker config show --resolved --reveal ``` * `--resolved`: Shows values in effect across the resolution chain, including registry and plist settings. * `--reveal`: Shows the API key unmasked in `--resolved` output, where it is masked by default. Only takes effect together with `--resolved`. `--resolved` output is often shared with support for investigation, so the API key is masked by default. Output produced with `--reveal` contains the key in full. Remove it before sharing. ### data Display records from a specified table in the local database. Runs in read-only mode while the daemon is active. ```bash theme={null} admina-tracker data [OPTIONS] ``` * `
`: Target table name (`service_usage`, `events`, `dynamic_state`, or `system_state`). Cannot specify `config`. `dynamic_state` and `system_state` telemetry is disabled by default. Support is planned for future versions. | Option | Description | | - | - | | `--limit ` | Maximum number of records to display (default: 20, range: 1–200) | | `--unsent` | Filter and show unsent rows only | ### flush Immediately send unsent records stored in the database to the server. ```bash theme={null} admina-tracker flush [TARGET] ``` * `[TARGET]`: Target table name (`service_usage`, `events`, `dynamic_state`, or `system_state`). If omitted, immediately flushes currently supported tables (`service_usage` and `events`). ## Maintenance Commands for database cleanup and maintenance tasks. ### cleanup Delete records older than a specified number of days from the local database. ```bash theme={null} admina-tracker cleanup [OPTIONS] ``` | Option | Description | | - | - | | `-d`, `--days ` | Number of elapsed days to retain (default: 30) | This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.