> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plaud.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Plaud CLI ドキュメント

> アプリを開くことなく、ターミナルからPlaudの録音データに直接アクセスして、データの閲覧、検索、文字起こしの確認、音声ファイルのダウンロード、AI要約の表示が可能です。

## 前提条件

* Node.js ≥ 20 — [ダウンロード](https://nodejs.org/)
* Plaudアカウント

***

## インストール

```bash theme={"system"}
npm install -g @plaud-ai/cli 
```

***

## クイックスタート

```bash theme={"system"}
plaud login # ブラウザ経由でログイン 
plaud files # 録音データの閲覧 
plaud search "Q2" # キーワードで録音データを検索 
plaud summary <id> # AI 要約の確認 
plaud transcript <id> # 文字起こし全体の確認
```

***

## コマンドリファレンス

### 認証

```bash theme={"system"}
plaud login # ブラウザ経由でログイン (トークンは自動保存されます)  
plaud logout # ログアウトおよび認証の取り消し 
plaud me # 現在のアカウント情報の表示 
```

### 閲覧

```bash theme={"system"}
plaud files # 最新の録音データ（最新ページ） 
plaud files --page 2 --page-size 50 
plaud recent # 過去 7 日間の録音データ 
plaud recent --days 30 # 過去 30 日間の録音データ 
plaud today # 今日の録音データのみ
```

**`plaud files `コマンドのオプション**

| オプション             | 説明                   | デフォルト値 |
| ----------------- | -------------------- | ------ |
| `-p, --page`      | ページ番号 (1～1000)       | `1`    |
| `-s, --page-size` | 1 ページあたりの件数 (10～100) | `20`   |

### 検索

```bash theme={"system"}
plaud search <キーワード> 
plaud search "週次定例" --from 2026-04-01 --to 2026-04-30 
plaud search "オンボーディング" --max 10 
```

録音ファイル名を対象とした、クライアントサイドでのキーワード検索です (英語での大文字・小文字は区別しません) 。直近の録音データ最大 500 件を検索対象とします。

| オプション                 | 説明                      |
| --------------------- | ----------------------- |
| `--from <YYYY-MM-DD>` | 検索対象期間の開始日 (指定日を含む)     |
| `--to <YYYY-MM-DD>`   | 検索対象期間の終了日 (指定日を含む)     |
| `--max <n>`           | 表示する最大結果件数 (デフォルト：`50`) |

### 録音データの詳細確認

```bash theme={"system"}
plaud file <id> # 完全なメタデータと利用可能状況の確認 
plaud audio <id> # 音声ファイルのダウンロード URL (24 時間有効) 
plaud transcript <id> # タイムスタンプ付きの文字起こし 
plaud transcript <id> -o transcript.txt # ファイルへの保存 
plaud summary <id> # AI 要約 (Markdown 形式) 
plaud summary <id> -o summary.md # ファイルへの保存
```

### ユーティリティ

```bash theme={"system"}
plaud version # インストール済みのバージョンとビルド情報の表示 
plaud update # 最新バージョンの確認とアップグレードコマンドの表示
```

***

## データ参照

### `plaud files` および `plaud file` のフィールド

| フィールド        | 説明                         |
| ------------ | -------------------------- |
| `id`         | 一意の録音 ID (他のコマンドで指定する際に使用) |
| `name`       | 録音データ名                     |
| `created_at` | 作成日時 (ISO 8601形式)          |
| `duration`   | 録音時間                       |

`plaud file <id>` のみに追加されるフィールド

| フィールド           | 説明                 |
| --------------- | ------------------ |
| `start_at`      | 録音開始日時 (ISO8601形式) |
| `serial_number` | デバイスのシリアル番号        |
| `audio`         | 音声ファイルのダウンロード可否    |
| `transcript`    | 文字起こしの利用可否         |
| `summary`       | AI 要約の利用可否         |

### 終了コード

| コード | 意味                              |
| --- | ------------------------------- |
| `0` | 成功                              |
| `1` | 無効な引数、または不明なエラー                 |
| `2` | 認証失敗 (plaud login を実行してください) \` |
| `3` | ネットワークエラー (接続状況を確認してください)       |
| `4` | リクエストのタイムアウト                    |

スクリプトやパイプ処理で標準出力 (stdout) をクリーンに保つため、エラーはすべて標準エラー出力 (**stderr**) に出力されます。

` ✖ [AUTH_FAILED] トークンが無効または期限切れです。「plaud login」を実行してください。`

***

## 設定

トークンは`~/.plaud/tokens.json`に自動で保存・管理されるため、手動での編集は不要です。

より高度な設定を行う場合は、以下の任意の設定ファイル`~/.plaud/cli.yaml` で構成できます。

```yaml theme={"system"}
api_base: "https://platform.plaud.ai/developer/api" timeout:30000 # milliseconds 
```

環境変数を設定した場合は、構成ファイルおよび組み込みのデフォルト値よりも優先されます。

| 変数                                        | 目的                 |
| ----------------------------------------- | ------------------ |
| `PLAUD_API_BASE`                          | API のベース URL を上書き  |
| `PLAUD_CLIENT_ID` / `PLAUD_CLI_CLIENT_ID` | OAuth クライアント ID    |
| `PLAUD_CLIENT_SECRET`                     | OAuth クライアントシークレット |
| `PLAUD_AUTH_URL`                          | 認可エンドポイント          |
| `PLAUD_TOKEN_URL`                         | トークン交換エンドポイント      |
| `PLAUD_REFRESH_URL`                       | トークンリフレッシュのエンドポイント |

***

## アップグレード

```bash theme={"system"}
npm install -g @plaud-ai/cli@latest 
```

または、事前に最新バージョンを確認する場合：

```bash theme={"system"}
plaud update 
```

***

## アンインストール

```bash theme={"system"}
npm uninstall -g @plaud-ai/cli 
rm -rf ~/.plaud 
```

***

## トラブルシューティング

| 症状                                   | 解決策                                                            |
| ------------------------------------ | -------------------------------------------------------------- |
| `401` / "Not authenticated"          | `plaud login` を実行する                                            |
| `plaud: command not found`           | ターミナルを再起動する。エラーなしで` npm install -g @plaud-ai/cli` が完了しているか確認する |
| トークンのリフレッシュエラー                       | `~/.plaud/tokens.json` を削除し、再度 `plaud login` を実行する             |
| ログイン時にブラウザが開かない                      | ターミナルに表示された URL をコピーし、ブラウザで手動で開く                               |
| `npx` で `@plaud-ai/cli` が `E404 `を返す | `npm cache clean --force `を実行して再試行する                           |