> ## 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 설치하기

설치 방법을 하나 선택하세요.

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가 필요하지 않습니다.
</Note>

## 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 설정 계획하기

앱의 패키지 또는 빌드 매니페스트가 있는 디렉터리로 이동하세요. 모노레포에서는 앱이나 서비스를 하나 선택하세요. 그다음 아래 명령어를 실행하세요.

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

`detected`, `install_ready`, `install_plan`, `next`를 읽으세요. 계획에는 런타임, 프레임워크, 패키지 관리자, 설치 명령어가 나옵니다. CLI는 패키지를 설치하거나 파일을 바꾸지 않습니다. `logbrew init`, `install`, `configure`, `sdk`도 같은 계획을 보여 줍니다.

<Warning>
  SDK 설정에는 프로젝트 수집 키를 넣으세요. 계정 자격 증명을 SDK 키로 쓰지 마세요. 수집 키를 소스 제어에 넣지 마세요.
</Warning>

런타임별 단계는 [SDK 연동](/ko/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`이 있습니다. 키를 바꾸려면 [수집 키 교체하기](/ko/guides/rotate-ingest-key)를 참고하세요.

이 명령어는 자격 증명을 만듭니다. 실행하기 전에 프로젝트가 맞는지 확인하세요. 결과가 불확실하면 같은 명령어를 다시 실행하세요. 그러면 CLI가 대기 중인 시도를 다시 사용합니다. 새 시도를 시작할 때만 `--abandon-retry`를 사용하세요.

새 프로젝트를 만들려면 [빠른 시작](/ko/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 보고서 레퍼런스](/ko/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`가 있습니다.

## 자주 하는 조사

모든 조회를 프로젝트로 필터링하세요. 명령어가 지원하면 릴리스, 환경, 시간, 심각도 필터도 추가하세요. [필터](/ko/reference/cli#filters)를 참고하세요.

<CardGroup cols={2}>
  <Card title="릴리스의 이슈" icon="tag">
    ```bash theme={null}
    logbrew read issues --project "<project_id>" --release api@1.2.3 --status unresolved --json
    ```
  </Card>

  <Card title="실패한 요청 1건" icon="route">
    ```bash theme={null}
    logbrew read trace "<trace_id>" --project "<project_id>" --json
    ```
  </Card>

  <Card title="릴리스의 로그" icon="file-text">
    ```bash theme={null}
    logbrew read logs --project "<project_id>" --release api@1.2.3 --since 24h --json
    ```
  </Card>

  <Card title="나에게 할당된 이슈" icon="user">
    ```bash theme={null}
    logbrew read issues --project "<project_id>" --assignee me --status unresolved --json
    ```
  </Card>
</CardGroup>

## 실시간 이벤트 지켜보기

변경 사항을 테스트하는 동안 새 이벤트를 보려면 watch를 사용하세요. 멈추려면 Ctrl+C를 누르세요.

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

watch는 JSON으로만 스트리밍합니다. `--json`이 없으면 명령어가 오류를 내고 멈춥니다. 한 가지 유형만 보려면 `logs`, `issues`, `actions` 중 하나를 추가하세요. 예를 들면 `logbrew watch logs --json`입니다. watch는 트레이스와 스팬을 지원하지 않습니다.

watch에는 프로젝트, 릴리스, 환경 필터가 없습니다. 프로젝트 하나만 보려면 위의 조회 명령어를 사용하세요. 지원하는 리소스와 필터는 [실시간 감시](/ko/reference/cli#live-watch)를 참고하세요.

## 코드를 바꾸기 전에 설명 읽기

수정안을 제안하기 전에 컨텍스트를 읽으세요.

<Steps>
  <Step title="이슈 읽기">
    ```bash theme={null}
    logbrew read issue "<issue_id>" --json
    ```
  </Step>

  <Step title="트레이스 읽기">
    이슈에 트레이스 ID가 있을 때만 이 단계를 진행하세요. 트레이스가 없는 이슈도 유효합니다.

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

  <Step title="설명 읽기">
    ```bash theme={null}
    logbrew explain issue "<issue_id>" --json
    ```

    로그에는 `logbrew explain log "<log_id>" --json`을 사용하세요. 액션에는 `logbrew explain action "<action_id>" --json`을 사용하세요.
  </Step>

  <Step title="검증 후 해결하기">
    ```bash theme={null}
    logbrew set issue "<issue_id>" resolved --json
    ```

    여러 이슈의 상태, 우선순위, 담당자를 바꾸려면 [이슈 상태와 우선순위 바꾸기](/ko/reference/cli#change-issue-status-and-priority)와 [이슈 관리](/ko/guides/issue-workflow)를 참고하세요.
  </Step>
</Steps>

## JSON 출력

* `--json`은 명령어 앞이나 뒤에 넣을 수 있습니다. 예를 들면 `logbrew --json status` 또는 `logbrew status --json`입니다.
* 출력을 사용하기 전에 종료 코드를 확인하세요.
* JSON 오류에는 `ok`, `error`, `message`, `next`가 있습니다. 시간 초과가 쓰기 실패를 증명하지는 않습니다. 쓰기를 반복하기 전에 해당 쓰기의 재시도 규칙을 읽으세요.
* `--json` 없이 나온 출력으로 자동화하지 마세요. 그 출력은 바뀔 수 있습니다.

종료 코드와 오류 예시는 [결과와 오류 읽기](/ko/reference/cli#read-results-and-errors)를 참고하세요.


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