Skip to main content

CLI Yabanin (yb)

yb ialah dua perkara dalam satu binari: audit perbelanjaan luar talian (yb audit) yang tidak pernah berhubung dengan rangkaian, dan klien pengendali yang ringkas yang memeriksa kesihatan perkhidmatan serta membaca data organisasi (kunci API, analitik kos/penjimatan) daripada API perkhidmatan baca-sahaja yabanin-admin (/internal/*).

# install (from the repository root)
go build -o bin/yb ./cmd/yb
bin/yb --help

Flag global​

FlagLalaiKeterangan
--admin-urlhttp://localhost:8086URL asas yabanin-admin yang dihubungi oleh perintah perkhidmatan
--api-key—Kunci perkhidmatan admin; dihantar sebagai pengepala X-Admin-Key (lihat di bawah)
--org—ID organisasi; diperlukan untuk keys list dan spend
--base-urlkesan automatikURL asas gerbang (digunakan oleh perintah yang menghadap gerbang)

Kunci perkhidmatan mesti sepadan dengan YABANIN_ADMIN_API_KEY yang dikonfigurasi pada pelayan yabanin-admin; tanpanya API perkhidmatan /internal langsung tidak dipasang. Lihat runbook pengeluaran — API perkhidmatan dalaman.

Jangan sekali-kali letakkan kunci sebenar dalam sejarah shell atau skrip yang dikomit — hantarkannya melalui --api-key atau pemboleh ubah persekitaran yang dikembangkan oleh shell anda secara tempatan.

Perintah​

yb version​

Mencetak versi CLI.

yb version
# yb 0.1.0

yb doctor​

Memeriksa gerbang (/healthz) dan panel admin (/health) hanya apabila pengendali menetapkan sasaran mereka dengan --base-url/--admin-url atau YABANIN_GATEWAY_URL/YABANIN_ADMIN_URL. Flag diutamakan berbanding pemboleh ubah persekitaran yang sepadan. Awalan laluan asas sedia ada dikekalkan. Mod pelaksanaan dan rantau tidak memilih sasaran secara automatik.

yb doctor --base-url http://localhost:8085 --admin-url http://localhost:8086
yb doctor --offline

--offline melangkau setiap permintaan, termasuk sasaran yang ditetapkan. Tanpa sasaran, semakan juga dilangkau. Kedua-dua kes melaporkan kesihatan sebagai tidak diketahui dan keluar dengan kod bukan sifar; ia tidak mengesahkan kesihatan perkhidmatan. Sasaran terpilih yang tidak sihat atau tidak dapat dihubungi juga keluar dengan kod bukan sifar. Pemeriksaan yang berjaya bagi setiap sasaran terpilih keluar dengan kod sifar.

Setiap permintaan mempunyai tamat masa lima saat, menghormati pembatalan perintah dan menolak penghalaan semula. Sasaran mestilah URL HTTP(S) tanpa kelayakan, parameter pertanyaan atau fragmen. Sasaran yang tidak sah ditolak tanpa permintaan; URL sasaran dan butiran pengangkutan ditinggalkan daripada diagnostik. Betulkan URL yang ditetapkan atau pulihkan ketersambungan perkhidmatan, kemudian jalankan semula perintah. Diagnostik ini merangkumi endpoint kesihatan yang dipilih; ia tidak mengaudit aliran keluar bahagian belakang atau pelayar.

yb keys list​

Menyenaraikan kunci API bagi satu organisasi (nama, status aktif, tarikh penciptaan). Senarai kunci tidak mengandungi bahan kunci teks biasa secara reka bentuk — stor admin hanya menyimpan hash.

yb keys list --org <org-id> --api-key <service-key>
# NAME STATUS CREATED
# deploy active 2026-08-01
# ci inactive 2026-07-01

Penomboran halaman: yb keys list --org <org-id> --api-key <service-key> --page 2 --page-size 10. Tanpa --page/--page-size, lalai pelayan (halaman 1, saiz 50) terpakai; apabila organisasi mempunyai lebih banyak kunci daripada yang muat pada satu halaman, petunjuk "Showing N of M keys" dicetak.

yb spend​

Menunjukkan analitik penjimatan organisasi untuk tetingkap imbas kembali: jumlah permintaan, kos sebenar berbanding kos kontrafaktual, penjimatan gabungan, dan pecahan mengikut model.

yb spend --org <org-id> --api-key <service-key>
yb spend --org <org-id> --api-key <service-key> --days 30 # -d 30

yb audit​

Penganalisis perbelanjaan luar talian. Halakannya kepada log permintaan LLM tempatan (JSONL, CSV, atau format gerbang ini). Ia melaporkan perbelanjaan sebenar dan penjimatan cache/penghalaan yang disimulasikan. Ia tidak memerlukan gerbang, URL admin, kunci API, atau organisasi, dan dalam --cache-mode exact (lalai) ia tidak membuat panggilan rangkaian.

yb audit path/to/traffic.jsonl
yb audit path/to/traffic.jsonl --format html --output report.html --no-prompts
FlagLalaiMaksud
--format, -fmdmd, json, atau html
--cache-modeexactexact, semantic, atau off
--output, -o(stdout)tulis laporan ke file ini
--no-promptsfalsegugurkan teks prompt mentah selepas dihashkan

--cache-mode semantic ialah satu-satunya laluan yang memerlukan embedder yang sedang berjalan. Gunakan exact untuk larian yang sepenuhnya luar talian. Semantik penuh, data sampel, dan apa yang tidak akan didakwa oleh laporan: Audit perbelanjaan luar talian.

Semantik ralat​

Ralat CLIMaksud
--api-key requiredflag --api-key tidak diberikan
org requiredflag --org tidak diberikan
admin service rejected the key: check --api-key and that yabanin-admin has YABANIN_ADMIN_API_KEY setHTTP 401 — kunci salah, atau pelayan admin tidak mempunyai YABANIN_ADMIN_API_KEY yang dikonfigurasi
admin service: org_id query parameter is requiredHTTP 400 — pengesahan organisasi di sisi pelayan
admin service unreachable at <url>sambungan ditolak / tamat masa (tamat masa klien 10s)

Nota keselamatan​

  • API perkhidmatan /internal ialah baca-sahaja dan terhad kepada skop organisasi: kedua-dua endpoint memerlukan org_id dan tidak mendedahkan operasi mutasi.
  • Perbandingan kunci ialah masa malar pada pelayan; nilai kunci tidak pernah dicatat dalam log oleh CLI atau pelayan.
  • Semua trafik ke API perkhidmatan tidak disahkan oleh kuki sesi — ia bertujuan untuk automasi tempatan/gelung balik. Dedahkan ia hanya kepada rangkaian yang dipercayai.