Skip to main content
LogBrew CLI (antarmuka baris perintah) membaca log, masalah, trace, dan aksi dari terminal. CLI juga dapat memperbarui status masalah. Gunakan --json untuk output terstruktur bagi skrip dan agen AI. Ganti setiap placeholder dalam kurung sudut sebelum menjalankan perintah. Gunakan ID proyek, masalah, dan trace yang dikembalikan LogBrew.

​
Instal CLI

Pilih satu metode instalasi. macOS atau Linux:
Windows (PowerShell):
Homebrew:
npm:
Cargo:
Di Windows, Anda juga dapat menginstal MSI dari rilis terbaru.
Cargo memerlukan Rust 1.87 atau yang lebih baru. Metode lain menginstal biner native dan tidak memerlukan Rust.

​
Perbarui CLI

CLI tidak memperbarui dirinya sendiri. Gunakan metode yang sama dengan saat Anda menginstalnya. Homebrew:
npm:
Cargo:
Jika Anda memakai installer shell atau PowerShell, jalankan installer itu lagi. Lalu baca versinya. Bandingkan dengan rilis terbaru:
JSON-nya berisi ok, name, version, binary, os, dan arch.

​
Masuk dan verifikasi sesi

Baca akun untuk terminal saat ini:
Jika whoami menampilkan akun yang diharapkan, lanjutkan. Jika tidak, masuk terlebih dahulu. Manusia menyelesaikan login penyedia di browser. Agen coding wajib meminta manusia melakukan langkah ini.
Penyedianya adalah github (default), gitlab, atau bitbucket. Gunakan --no-open untuk mencetak URL login tanpa membuka browser. --json juga mencetak data handoff login tanpa membuka browser. Setelah login, jalankan status dan whoami lagi. Jangan masukkan kredensial akun ke prompt, laporan, atau file sumber.

​
Rencanakan penyiapan SDK

Pindah ke direktori yang berisi manifes paket atau manifes build aplikasi. Di monorepo, pilih satu aplikasi atau layanan. Lalu jalankan:
Baca detected, install_ready, install_plan, dan next. Rencana ini berisi runtime, framework, package manager, dan perintah instalasi. CLI tidak menginstal paket atau mengubah file. logbrew init, install, configure, dan sdk memberikan rencana yang sama.
Masukkan kunci ingest proyek ke konfigurasi SDK. Jangan pernah memakai kredensial akun sebagai kunci SDK. Jangan simpan kunci ingest di source control.
Lihat panduan Integrasi SDK untuk langkah khusus setiap runtime. Jalankan logbrew examples untuk melihat daftar singkat perintah umum.

​
Baca, buat, dan konfigurasikan proyek

Tampilkan daftar proyek aktif di akun Anda:
Pilih ID proyek dari hasilnya. Gunakan ID itu untuk kunci dan pembacaan data. Untuk membuat kunci ingest bagi proyek yang sudah ada, pilih file baru di luar source control. CLI menulis kunci ke file itu, yang hanya dapat diakses pemiliknya. CLI tidak mencetak kunci atau path file-nya.
Hasil JSON berisi status, project_id, ingest_key, checks, dan next. ingest_key berisi id, label, kind, created_at, dan expires_at dari kunci tersebut. Untuk mengganti kunci, lihat Rotasikan kunci ingest. Perintah ini membuat kredensial. Sebelum menjalankannya, pastikan proyeknya benar. Jika hasilnya tidak pasti, jalankan perintah yang sama lagi. CLI lalu memakai ulang percobaan yang masih tertunda. Gunakan --abandon-retry hanya untuk memulai percobaan baru. Untuk membuat proyek baru, ikuti panduan Mulai cepat. Panduan itu memakai logbrew projects create "<name>" --ingest-key-file "<private_key_file>", yang menyimpan kunci pertama dengan cara yang sama. Jalankan logbrew setup --create-project untuk membaca bantuan pembuatan proyek. Perintah itu tidak membuat proyek. Setelah menyelesaikan satu langkah penyiapan, Anda dapat mencatatnya untuk proyek. Nilai --source adalah api, cli, atau sdk:
Lalu baca kesiapan proyek:
Kode keluar 0 tidak berarti semua pemeriksaan lolos. Baca status laporan dan setiap pemeriksaan. Lihat Baca laporan doctor proyek.

​
Baca penggunaan akun

Baca penggunaan dan batas. Perintah ini tidak mengubah status akun atau penagihan.
logbrew account usage --json memberikan hasil yang sama. Respons berisi paket, status kuota, tanggal reset, total penggunaan per proyek dan per jenis telemetri, serta langkah berikutnya. Kolomnya meliputi plan, state, reset_at, by_project, by_stream, dan next.

​
Investigasi umum

Filter setiap pembacaan menurut proyek. Tambahkan filter rilis, lingkungan, waktu, atau tingkat keparahan jika perintahnya mendukung. Lihat Filter.

Masalah dalam satu rilis

Satu permintaan yang gagal

Log untuk satu rilis

Masalah yang ditugaskan ke Anda

​
Pantau peristiwa langsung

Gunakan perintah watch untuk melihat peristiwa baru saat Anda menguji perubahan. Tekan Ctrl+C untuk berhenti.
Perintah watch hanya men-stream JSON. Tanpa --json, perintah berhenti dengan error. Tambahkan logs, issues, atau actions untuk memantau satu jenis saja, misalnya logbrew watch logs --json. Perintah watch tidak mendukung trace atau span. Perintah watch tidak punya filter proyek, rilis, atau lingkungan. Untuk satu proyek, gunakan perintah baca di atas. Lihat Pantauan langsung untuk resource dan filter yang didukung.

​
Minta penjelasan sebelum mengubah kode

Baca konteksnya sebelum mengusulkan perbaikan.
1

Baca masalah

2

Baca trace

Lakukan langkah ini hanya jika masalah memiliki ID trace. Masalah tanpa trace tetap valid.
3

Baca penjelasan

Untuk log, gunakan logbrew explain log "<log_id>" --json. Untuk aksi, gunakan logbrew explain action "<action_id>" --json.
4

Selesaikan setelah verifikasi

Untuk mengubah status, prioritas, atau penanggung jawab banyak masalah, lihat Ubah status dan prioritas masalah dan panduan Kelola masalah.

​
Output JSON

  • Letakkan --json sebelum atau sesudah perintah, misalnya logbrew --json status atau logbrew status --json.
  • Baca kode keluar sebelum memakai output-nya.
  • Error JSON berisi ok, error, message, dan next. Timeout tidak membuktikan bahwa operasi tulis gagal. Sebelum mengulang operasi tulis, baca aturan percobaan ulangnya.
  • Jangan membuat otomatisasi dengan output tanpa --json. Output itu dapat berubah.
Lihat Baca hasil dan error untuk kode keluar dan contoh error.