> ## 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 コマンドリファレンス

> Admina Tracker のコマンドラインインターフェース（admina-tracker）の構文、サブコマンド、設定オプション、診断機能のリファレンスです。

`admina-tracker` コマンドラインツールは、エージェントの動作状態の確認、ライフサイクル管理、設定値の確認・更新、データの診断、サーバーへの即時送信に利用する CLI ツールです。

## コマンドの実行方法

`admina-tracker` コマンドは、インストール方式によって実行方法が異なります。

* macOS — `/usr/local/bin` は標準で PATH に含まれているため、ターミナルからそのまま実行できます。
* Windows:
  * 単独インストーラーでインストールした場合 — `%LOCALAPPDATA%\AdminaTracker` がユーザー環境変数 `PATH` に自動追加されるため、コマンドプロンプトや PowerShell から `admina-tracker` をそのまま実行できます。
  * Microsoft Intune で配布した場合 — 環境変数 `PATH` には追加されないため、以下のように実行ファイルのフルパスを指定して実行します。
    ```powershell theme={null}
    & "$env:LOCALAPPDATA\AdminaTracker\admina-tracker.exe" status
    ```
    コマンドプロンプトの場合:
    ```cmd theme={null}
    "%LOCALAPPDATA%\AdminaTracker\admina-tracker.exe" status
    ```

基本構文は以下のとおりです。

```bash theme={null}
admina-tracker [OPTIONS] <COMMAND>
```

### 共通オプション

| オプション | 説明 |
| - | - |
| `-h`, `--help` | ヘルプ情報を表示します |
| `--db-path <PATH>` | データベースのパスを指定します（環境変数: `ADMINA_TRACKER_DB_PATH`）。通常は既定のパスが自動的に使用されるため、指定する必要はありません |

## ライフサイクル

エージェントの起動、停止、再起動、更新確認などのライフサイクルを管理するコマンドです。

### daemon

エージェントをフォアグラウンドで起動します。

```bash theme={null}
admina-tracker daemon
```

### stop

実行中のエージェントデーモンを停止します。

```bash theme={null}
admina-tracker stop
```

* macOS — `launchctl bootout` を実行して LaunchAgent を停止します。
* Windows — 登録されたタスクまたはサービスを停止するか、実行中のユーザープロセスを終了します。

### restart

エージェントデーモンを再起動します。

```bash theme={null}
admina-tracker restart
```

* macOS — LaunchAgent を再読み込みしてエージェントを再起動します。
* Windows — 登録されたサービスまたはタスクの仕組みを介してプロセスを停止し、再起動します。

### update

エージェントのアップデートの有無を確認します。

```bash theme={null}
# アップデートの有無を確認
admina-tracker update

# 利用可能なアップデートが存在する場合に直ちに適用
admina-tracker update --apply
```

### version

エージェントのバージョンおよびビルド情報を表示します。

```bash theme={null}
admina-tracker version
```

### enroll

サーバーへのエンロール（登録）を手動で即座に実行します。

```bash theme={null}
admina-tracker enroll
```

エージェント起動時の自動試行やバックオフ再試行を待たず、初回エンロールで失敗した端末を手動で再試行させたいときに役立ちます。

## 設定

API 接続設定やテレメトリフラグを設定するコマンドです。

### configure

API 接続設定を行います。

```bash theme={null}
admina-tracker configure [OPTIONS]
```

| オプション | 説明 |
| - | - |
| `--api-key <値>` | API キーを設定します |
| `--organization-id <値>` | Organization ID を設定します |
| `--serial-number <値>` | シリアル番号を手動で設定します |
| `--user-email <値>` | 利用者のメールアドレスを設定します |

### config set

テレメトリの収集・送信フラグを設定します。

```bash theme={null}
admina-tracker config set <KEY> <VALUE>
```

* `<KEY>`: 設定対象のフラグキー（`telemetry_*`）。安全のため認識されているテレメトリフラグのみ変更可能で、任意の構成値を直接書き換えることはできません（認証情報は `configure` コマンドで設定します）。
* `<VALUE>`: `true` または `false`。

## 診断

エージェントの動作状態や保存されているデータテーブルの内容を確認するコマンドです。

### status

ローカルの診断状態を表示します。

```bash theme={null}
admina-tracker status
```

エージェントの稼働状態、サービス・スケジュールタスクの設定、設定値の解決チェーン、収集データの保存件数、実行バイナリやログファイルのパス情報などが読み取り専用で表示されます。ネットワーク通信は行いません。

設定値の解決チェーンでは、`ApiKey`・`OrganizationID`・`UserEmail` について参照元ごとの値が並び、実際に採用された行に `**` が付きます。どの配布経路の値が効いているかは、この印で判断できます。

あわせて Hostname と Proxy も表示されます。

Hostname は OS が報告する端末名で、イベントログの検出元 PC として使われます。macOS ではカーネルのホスト名（`sysctl kern.hostname` の値）、Windows では DNS ホスト名を使います。どちらも `hostname` コマンドで表示される名前と同じです。環境変数 `HOSTNAME` や `COMPUTERNAME` は参照しません。設定での上書きはできません。

Proxy は `env var`（環境変数）、`OS setting`（OS のプロキシ設定。Windows でのみ読み取ります）、`effective`（実際に使われる経路）、`NO_PROXY`（バイパス一覧）の4行です。プロキシ URL に資格情報が含まれる場合、パスワード部分はマスクされます。

### diag

ローカルの診断状態（`status` の表示内容）に加えて、サーバーへの疎通確認と認証確認をその場で実行します。

```bash theme={null}
admina-tracker diag
```

`status` がローカルデータベースやレジストリ・plist の状態のみを読み取り専用で確認するのに対し、`diag` は実際にネットワーク通信し、以下をリアルタイムに検証します。

* サーバー（API エンドポイント）への DNS 解決、TCP 接続、TLS ハンドシェイクの疎通確認
* 解決された API キーを用いたサーバー認証の成功可否および組織 ID の整合性
* 端末とサーバーの時刻の同期状態（クロックスキューの有無）

結果は `Checks` セクションに `PASS` / `WARN` / `FAIL` / `SKIP` の判定付きで並び、末尾に失敗と警告の件数が出ます。`FAIL` や `WARN` があった場合は、`->` で始まる対処の案内が続きます。

<Info>
  時刻の同期状態はサーバー認証の応答から判定するため、認証が `SKIP` または `FAIL` になった場合は確認されません。

  `Connectivity` の判定は TLS ハンドシェイクが成立したかどうかで決まります。サーバーが HTTP エラーを返した場合でも、応答が返っている以上ハンドシェイクは成立しているため `PASS` になります。
</Info>

<Frame caption="Windows で diag を実行したところ">
  <img src="https://mintcdn.com/moneyforwardi/kynxLzvSv1AlDGBj/images/it-management/admina-tracker/cli-command-reference/diag-output-01.png?fit=max&auto=format&n=kynxLzvSv1AlDGBj&q=85&s=50bb7f0a34295c49eaad3a7f9370834b" alt="PowerShell で admina-tracker.exe diag を実行し、Runtime セクションにエージェントのバージョン、API のベース URL、OS、ホスト名、デーモンの稼働状況、スケジュールタスクの状態が並んでいる画面" style={{ maxWidth: "100%", height: "auto" }} width="2596" height="1248" data-path="images/it-management/admina-tracker/cli-command-reference/diag-output-01.png" />
</Frame>

### config show

保存されている設定情報（`api_key`、`organization_id`、`user_email`）を JSON 形式で出力します。

```bash theme={null}
# ローカルデータベースに保存された設定を表示
admina-tracker config show

# ポリシー設定や環境変数を含めて解決された最新の設定を表示
admina-tracker config show --resolved

# API キーをマスクせずに表示
admina-tracker config show --resolved --reveal
```

* `--resolved`: データベース内のキャッシュだけでなく、レジストリや plist 経由の値も含めて実際に適用されている値を表示します（定期送信サイクルと同じ解決チェーンを通します）。
* `--reveal`: `--resolved` の出力で既定ではマスクされる API キーを、マスクせずに表示します。`--resolved` と併用したときのみ有効です。

<Warning>
  `--resolved` の出力は調査のためにサポートへ共有されることがあるため、API キーは既定でマスクされます。`--reveal` を付けた出力には API キーがそのまま含まれます。共有する前に必ず取り除いてください。
</Warning>

### data

ローカルデータベースの指定したテーブルからレコードを表示します。デーモンが起動したままでも読み取り専用で実行できます。

```bash theme={null}
admina-tracker data <TABLE> [OPTIONS]
```

* `<TABLE>`: 表示対象のテーブル名を指定します（`service_usage`、`events`、`dynamic_state`、`system_state` のいずれか。`config` や `device_info` は指定できません）。

<Info>
  `dynamic_state` および `system_state` は、現行バージョンではテレメトリフラグがデフォルトで無効となっているためサーバーには送信されません。今後のバージョンで送信に対応する予定です。
</Info>

| オプション | 説明 |
| - | - |
| `--limit <数>` | 表示する最大件数を指定します（デフォルト: 20、範囲: 1〜200） |
| `--unsent` | 未送信の行のみを抽出して表示します |

### flush

データベース内に蓄積されている未送信データを直ちにサーバーへ送信します。

```bash theme={null}
admina-tracker flush [TARGET]
```

* `[TARGET]`: 送信対象のテーブル名（`service_usage`、`events`、`dynamic_state`、`system_state` のいずれか）を指定します。省略した場合は、現在サポートされているテーブルの両方（`service_usage` および `events`）を直ちに送信します。

## メンテナンス

データベースのクリーンアップなどを行うコマンドです。

### cleanup

指定した日数より古いローカルデータをデータベースから削除します。

```bash theme={null}
admina-tracker cleanup [OPTIONS]
```

| オプション | 説明 |
| - | - |
| `-d`, `--days <日数>` | 削除対象とする経過日数を指定します（デフォルト: 30） |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.