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

# クイックスタート

> 実践的な 5 つの CLI シナリオ — ノートの一覧表示から、検索結果をシェルへ一括パイプするところまで。

日々の CLI ワークフローのほとんどをカバーする、コピー＆ペーストできる 5 つのシナリオです。いずれもデータの入ったテナントに対して 30 秒以内で実行できます。

## 1. 最近のノートを一覧表示する

```bash theme={"system"}
tiro notes list --limit 10
```

TTY での見やすい出力:

```
2026-04-02  note-a8f2c1...  18m32s  Q3 Planning
2026-04-01  note-b7e1d4...  12m05s  Customer call with Acme Corp
2026-03-29  note-c3f9a2...  45m11s  Engineering weekly standup
…
```

パイプ用に NDJSON へ切り替えるには `--json` を追加します:

```bash theme={"system"}
tiro notes list --limit 100 --json | jq -r '.guid' | head -5
```

## 2. キーワードと日付範囲で検索する

```bash theme={"system"}
tiro notes search "OKR" --since 30d --json
```

`tiro notes search` は Tiro のディープ検索を使用します。各結果は、その主要ドキュメント（one-pager、custom）が付与されたノートです。キーワードは必須です（位置引数または `--keyword`）。

日付フィルターは ISO-8601 または相対表記の短縮形を受け付けます:

```bash theme={"system"}
tiro notes search "Q3 Planning" --since 2026-04-01 --until 2026-05-01
tiro notes search "Acme Corp"   --since 7d
tiro notes search "release"     --since 24h
```

フォルダ単位での絞り込み:

```bash theme={"system"}
tiro notes search "deploy" --folder <folderId> --json
```

### キーワードマッチングの仕組み

`tiro notes search` は、ノートのタイトルと段落コンテンツに対する Tiro の全文検索インデックスへクエリを発行します。マッチは大文字小文字を区別せず、トークン化されます。つまり `"OKR planning"` は、リテラルなフレーズではなく "OKR" と "planning" の両方を含むノートを返します。結果は関連度で並び替えられ、同点の場合は `createdAt` の降順がタイブレーカーになります。

ディープ版（このコマンド、`POST /v1/external/notes/search`）は、各ノートにその主要ドキュメント（one-pager、custom）も付与するため、LLM クライアントは 1 回の呼び出しでメタデータとコンテンツを併せて読み取れます。より軽量な `tiro notes list --keyword "..."` はメタデータのみを返します。

`--keyword` を指定しない場合、`tiro notes list` は結果を `createdAt desc` で並び替えます。`--keyword` を指定した場合、ページネーションカーソルは常に `null` になります（レスポンスは検索インデックスが返す範囲に限定されます）。

<Note>
  **プレースホルダーフィルター。** `tiro notes list` と `tiro notes search` はいずれも、デフォルトでプレースホルダーのノート（`title === "Untitled"` または `sourceType === "onboarding"`）を除外します。N 件のページでも、表示されるノートが N 件未満になる場合があります。それらを表示するには `--include-untitled` を渡してください。
</Note>

## 3. 1 件の会議ノートを Markdown として保存する

```bash theme={"system"}
tiro notes get <noteGuid> --output ./q3-planning.md --include transcript
```

stdout にはメタデータが 1 行返り、実際のコンテンツはディスクに出力されます:

```json theme={"system"}
{"ok":true,"data":{"saved":"./q3-planning.md","size":12450,"format":"md","guid":"note-a8f2c1...","title":"Q3 Planning"}}
```

Markdown ファイルには YAML フロントマター、参加者リスト、そして段落ごとに 1 つの経過タイムスタンプヘッダーと、それに続く話者ごとのセグメントを含むトランスクリプトが格納されます:

```md theme={"system"}
### 00:12

**Yeoul**: Let's start with the Acme deal pipeline.
**Evan**: They just signed the LOI.
```

`--no-timestamps`（v0.3.0+）を渡すと `### mm:ss` ヘッダーを完全に除去できます。タイムスタンプがノイズになる生のままの保存や LLM への取り込みに便利です:

```bash theme={"system"}
tiro notes transcript <noteGuid> --output ./clean.md --no-timestamps
```

## 4. 検索結果を `jq` にパイプする

```bash theme={"system"}
tiro notes search "OKR" --since 7d --json \
  | jq -r 'select(.recordingDurationSeconds > 600) | .guid' \
  > long-okr-meetings.txt
```

`--json` は list/search のレスポンスに対して常に NDJSON を出力します（ノート 1 件につき 1 行）。さらにパイプライン処理を行うには `jq -c`（コンパクト）と組み合わせ、スライスするには `head` / `tail` と組み合わせます。

レスポンスに次ページのカーソルが含まれる場合、それは `_cursor` をキーとする最後の NDJSON 行として出力されます:

```bash theme={"system"}
tiro notes list --limit 50 --json | tail -1
# → {"_cursor":"eyJjcmVhdGVkQXQi…"}
```

続きを取得するには、それを `--cursor` として渡し直します:

```bash theme={"system"}
tiro notes list --limit 50 --cursor "eyJjcmVhdGVkQXQi…"
```

## 5. 話者ラベル付きのトランスクリプトを取得する

```bash theme={"system"}
tiro notes transcript <noteGuid> --format md --output ./transcript.md
```

```md theme={"system"}
# Customer call with Acme Corp

**Participants**: Yeoul, Evan, Hailey

## Transcript

### 00:00

**Yeoul**: Thanks for joining — let me walk through the proposal.

### 00:12

**Hailey**: One quick question on pricing tiers.

### 00:25

**Evan**: That's covered on slide 4.
…
```

MCP の `get_note_transcript` ペイロードをすでに理解しているエージェント向けには、`--format json` に切り替えてください。形式はバイト単位で同一です:

```bash theme={"system"}
tiro notes transcript <noteGuid> --format json
```

```json theme={"system"}
{
  "noteGuid": "note-a8f2c1...",
  "title": "Customer call with Acme Corp",
  "participants": ["Yeoul", "Evan", "Hailey"],
  "createdAt": "2026-04-01T10:30:00Z",
  "recordingDurationSeconds": 3605,
  "paragraphs": [
    {
      "timeFrom": "2026-04-01T10:30:00Z",
      "timeTo":   "2026-04-01T10:30:12Z",
      "segments": [
        { "content": "Thanks for joining…",
          "speaker": { "label": "SPEAKER_0", "name": "Yeoul" } }
      ]
    },
    …
  ]
}
```

## 6. ワークスペースの Wiki を探索する

Wiki は、Tiro がノートから自動抽出したナレッジグラフ（エンティティ、コンセプト、およびそれらのリンク）です。これらのコマンドはすべて読み取り専用で、Wiki が有効化されたワークスペース（有料・オプトイン）が必要です。

```bash theme={"system"}
tiro wiki workspaces                                   # which workspaces? (guid + wiki on/off)
tiro wiki search "payment system" --workspace <guid>   # ranked pages; <query> is positional
tiro wiki page <pageGuid> --workspace <guid>           # body + mentions + aliases + links (all included)
tiro wiki mentions <pageGuid> --workspace <guid>       # where the page is grounded in your notes
tiro wiki graph <pageGuid> --mode around --workspace <guid>    # neighborhood graph (capped — see `truncated`)
tiro wiki graph --mode seed --type CONCEPT --workspace <guid>  # overview graph — no pageGuid needed
```

`--workspace` は省略可能です。指定しない場合は、お使いの API キーのデフォルトワークスペースが使用されます。アカウントが複数のワークスペースに属している場合は、まず `tiro wiki workspaces` を実行し、Wiki が有効になっている `guid` を渡してください。ゲート対象のワークスペースでは、バックエンドのアップグレード案内が表示され、非ゼロの終了コードで終了します。

→ ツール選択のガイダンスと実践的なエージェントフローについては [For AI agents](/ja/developers/cli/agent-guide) へ進んでください。