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

# LogBrew CLI のインストールと使い方

> macOS、Linux、Windows に LogBrew CLI をインストールします。サインインしてプロジェクトを選び、JSON 出力で課題を調査します。

LogBrew のコマンドラインインターフェース（CLI）は、ターミナルからログ、課題、トレース、アクションを読み取ります。課題のステータスも更新できます。スクリプトや AI エージェントに構造化された出力を渡すには `--json` を使います。

コマンドを実行する前に、山かっこのプレースホルダーをすべて置き換えてください。プロジェクト、課題、トレースの ID には、LogBrew が返した値を使います。

## CLI をインストールする

インストール方法を1つ選びます。

macOS または Linux:

```bash theme={null}
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/LogBrewCo/cli/releases/latest/download/logbrew-cli-installer.sh | sh
```

Windows（PowerShell）:

```powershell theme={null}
powershell -ExecutionPolicy Bypass -c "irm https://github.com/LogBrewCo/cli/releases/latest/download/logbrew-cli-installer.ps1 | iex"
```

Homebrew:

```bash theme={null}
brew install LogBrewCo/tap/logbrew
```

npm:

```bash theme={null}
npm install -g logbrew-cli@latest
```

Cargo:

```bash theme={null}
cargo install logbrew-cli
```

Windows では、[最新のリリース](https://github.com/LogBrewCo/cli/releases/latest)から MSI をインストールすることもできます。

> [!NOTE]
>
> Cargo には Rust 1.87 以降が必要です。他の方法はネイティブのバイナリをインストールするため、Rust は不要です。

## CLI を更新する

CLI は自動では更新されません。インストールしたときと同じ方法で更新します。

Homebrew:

```bash theme={null}
brew update && brew upgrade LogBrewCo/tap/logbrew
```

npm:

```bash theme={null}
npm install -g logbrew-cli@latest
```

Cargo:

```bash theme={null}
cargo install --locked logbrew-cli
```

シェルや PowerShell のインストーラーを使った場合は、インストーラーをもう一度実行します。

次にバージョンを確認し、[最新のリリース](https://github.com/LogBrewCo/cli/releases/latest)と比べます。

```bash theme={null}
logbrew version --json
```

JSON には `ok`、`name`、`version`、`binary`、`os`、`arch` が含まれます。

## サインインしてセッションを確認する

現在のターミナルのアカウントを確認します。

```bash theme={null}
logbrew status --json
logbrew whoami --json
```

`whoami` に想定どおりのアカウントが表示されたら、次に進みます。表示されない場合はサインインします。プロバイダーへのログインは、人がブラウザーで完了します。コーディングエージェントは、この手順を人に依頼する必要があります。

```bash theme={null}
logbrew login --provider github
```

プロバイダーは `github`（デフォルト）、`gitlab`、`bitbucket` のいずれかです。ブラウザーを開かずにログイン URL を表示するには `--no-open` を使います。`--json` でも、ブラウザーを開かずにログインの引き継ぎ情報を表示します。

ログイン後に、`status` と `whoami` をもう一度実行します。アカウントの認証情報をプロンプト、レポート、ソースファイルに書かないでください。

## SDK のセットアップを計画する

アプリのパッケージマニフェストまたはビルドマニフェストがあるディレクトリに移動します。モノレポでは、アプリまたはサービスを1つ選びます。次に、以下を実行します。

```bash theme={null}
logbrew setup --json
```

`detected`、`install_ready`、`install_plan`、`next` を読みます。プランには、ランタイム、フレームワーク、パッケージマネージャー、インストールコマンドが含まれます。CLI はパッケージのインストールやファイルの変更を行いません。`logbrew init`、`install`、`configure`、`sdk` も同じプランを返します。

> [!WARNING]
>
> SDK の設定には、プロジェクトの取り込みキーを入れてください。アカウントの認証情報を SDK のキーとして使わないでください。取り込みキーはソース管理に含めないでください。

ランタイムごとの手順は、[SDK 連携](/ja/guides/sdk-ingestion)を参照してください。よく使うコマンドの短い一覧は `logbrew examples` で表示できます。

## プロジェクトを読み取り、作成し、設定する

アカウントのアクティブなプロジェクトを一覧表示します。

```bash theme={null}
logbrew projects --json
```

結果からプロジェクト ID を選びます。キーの作成と読み取りにはこの ID を使います。

既存のプロジェクトに取り込みキーを作成するには、ソース管理の外にある新しいファイルを指定します。CLI は、所有者だけが読めるそのファイルにキーを書き込みます。キーやファイルのパスは表示しません。

```bash theme={null}
logbrew projects keys create "<project_id>" --ingest-key-file "<private_key_file>" --json
```

| フラグ | 値 |
| - | - |
| `--kind` | `sdk`（デフォルト）、`browser`、`server`、`cli`、`artifact` のいずれか。`artifact` キーはソースマップとネイティブのデバッグファイルをアップロードします。テレメトリは送信できません。 |
| `--label` | キーの名前。120文字まで指定できます。デフォルトは `CLI-created SDK key` です。 |

JSON の結果には `status`、`project_id`、`ingest_key`、`checks`、`next` が含まれます。`ingest_key` には、キーの `id`、`label`、`kind`、`created_at`、`expires_at` が含まれます。キーを置き換えるには、[取り込みキーのローテーション](/ja/guides/rotate-ingest-key)を参照してください。

このコマンドは認証情報を作成します。実行する前に、プロジェクトが正しいことを確認してください。結果がはっきりしない場合は、同じコマンドをもう一度実行します。CLI は保留中の試行を再利用します。新しい試行を始めるときだけ `--abandon-retry` を使います。

新しいプロジェクトを作成するには、[クイックスタート](/ja/quickstart)の手順に従います。クイックスタートでは `logbrew projects create "<name>" --ingest-key-file "<private_key_file>"` を使い、最初のキーを同じ方法で保存します。プロジェクト作成のヘルプを読むには `logbrew setup --create-project` を実行します。このコマンドはプロジェクトを作成しません。

セットアップの手順を終えたら、その手順をプロジェクトに記録できます。`--source` の値は `api`、`cli`、`sdk` のいずれかです。

```bash theme={null}
logbrew projects setup "<project_id>" --source cli --environment production --json
```

次に、プロジェクトの準備状況を確認します。

```bash theme={null}
logbrew doctor --project "<project_id>" --json
```

終了コード `0` は、すべてのチェックに合格したことを意味しません。レポートの `status` と各チェックを読んでください。[doctor レポートのリファレンス](/ja/reference/cli#read-a-project-doctor-report)を参照してください。

## アカウントの使用量を確認する

使用量と上限を確認します。アカウントや請求の状態は変わりません。

```bash theme={null}
logbrew usage --json
```

`logbrew account usage --json` も同じ結果を返します。レスポンスには、プラン、クォータの状態、リセット日、プロジェクト別とテレメトリの種類別の使用量の合計、次の手順が含まれます。フィールドには `plan`、`state`、`reset_at`、`by_project`、`by_stream`、`next` があります。

## よく行う調査

それぞれの読み取りをプロジェクトで絞り込みます。コマンドが対応していれば、リリース、環境、時間、重大度のフィルターも追加します。[フィルター](/ja/reference/cli#filters)を参照してください。

> **リリースの課題**
>
> ```bash theme={null}
> logbrew read issues --project "<project_id>" --release api@1.2.3 --status unresolved --json
> ```

> **失敗した1件のリクエスト**
>
> ```bash theme={null}
> logbrew read trace "<trace_id>" --project "<project_id>" --json
> ```

> **リリースのログ**
>
> ```bash theme={null}
> logbrew read logs --project "<project_id>" --release api@1.2.3 --since 24h --json
> ```

> **自分に割り当てられた課題**
>
> ```bash theme={null}
> logbrew read issues --project "<project_id>" --assignee me --status unresolved --json
> ```

## ライブイベントを監視する

変更をテストしながら新しいイベントを確認するには、watch を使います。停止するには Ctrl+C を押します。

```bash theme={null}
logbrew watch --severity error,critical --json
```

watch は JSON だけをストリーミングします。`--json` を付けないと、コマンドはエラーで停止します。1つの種類だけを監視するには、`logbrew watch logs --json` のように `logs`、`issues`、`actions` を追加します。watch はトレースとスパンに対応していません。

watch には、プロジェクト、リリース、環境のフィルターがありません。1つのプロジェクトに絞るには、上の読み取りコマンドを使います。対応するリソースとフィルターについては、[ライブ監視](/ja/reference/cli#live-watch)を参照してください。

## コードを変更する前に説明を読む

修正を提案する前に、コンテキストを読みます。

**1. 課題を読む**

```bash theme={null}
logbrew read issue "<issue_id>" --json
```

**2. トレースを読む**

課題にトレース ID がある場合だけ、この手順を行います。トレースのない課題も有効です。

```bash theme={null}
logbrew read trace "<trace_id>" --project "<project_id>" --json
```

**3. 説明を読む**

```bash theme={null}
logbrew explain issue "<issue_id>" --json
```

ログには `logbrew explain log "<log_id>" --json` を使います。アクションには `logbrew explain action "<action_id>" --json` を使います。

**4. 確認してから解決する**

```bash theme={null}
logbrew set issue "<issue_id>" resolved --json
```

多くの課題のステータス、優先度、担当者を変更するには、[課題のステータスと優先度を変更する](/ja/reference/cli#change-issue-status-and-priority)と[課題を管理する](/ja/guides/issue-workflow)を参照してください。

## JSON 出力

* `--json` は、`logbrew --json status` や `logbrew status --json` のように、コマンドの前にも後にも置けます。
* 出力を使う前に、終了コードを確認します。
* JSON のエラーには `ok`、`error`、`message`、`next` が含まれます。タイムアウトは、書き込みが失敗したことの証明にはなりません。書き込みを繰り返す前に、その再試行のルールを読んでください。
* `--json` なしの出力を自動化に使わないでください。形式が変わることがあります。

終了コードとエラーの例については、[結果とエラーを読む](/ja/reference/cli#read-results-and-errors)を参照してください。


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