CLI commands

Model

openclaw models

Penemuan, pemindaian, dan konfigurasi model (model default, fallback, profil auth).

Terkait:

  • Penyedia + model: Model
  • Konsep pemilihan model + perintah slash /models: Konsep model
  • Penyiapan auth penyedia: Memulai

Perintah umum

openclaw models status
openclaw models list
openclaw models set <model-or-alias>
openclaw models scan

openclaw models status menampilkan default/fallback yang di-resolve serta ringkasan auth. Saat snapshot penggunaan penyedia tersedia, bagian status OAuth/kunci API menyertakan jendela penggunaan penyedia dan snapshot kuota. Penyedia jendela penggunaan saat ini: Anthropic, GitHub Copilot, Gemini CLI, OpenAI Codex, MiniMax, Xiaomi, dan z.ai. Auth penggunaan berasal dari hook khusus penyedia jika tersedia; jika tidak, OpenClaw melakukan fallback ke kredensial OAuth/kunci API yang cocok dari profil auth, env, atau konfigurasi. Dalam output --json, auth.providers adalah ringkasan penyedia yang sadar env/konfigurasi/store, sedangkan auth.oauth hanya kesehatan profil auth-store. Tambahkan --probe untuk menjalankan probe auth langsung terhadap setiap profil penyedia yang dikonfigurasi. Probe adalah permintaan nyata (dapat mengonsumsi token dan memicu batas laju). Gunakan --agent <id> untuk memeriksa status model/auth agen yang dikonfigurasi. Jika dihilangkan, perintah menggunakan OPENCLAW_AGENT_DIR/PI_CODING_AGENT_DIR jika disetel, jika tidak agen default yang dikonfigurasi. Baris probe dapat berasal dari profil auth, kredensial env, atau models.json. Untuk pemecahan masalah OAuth Codex, openclaw models status, openclaw models auth list --provider openai-codex, dan openclaw config get agents.defaults.model --json adalah cara tercepat untuk mengonfirmasi apakah agen memiliki profil auth openai-codex yang dapat digunakan untuk openai/* melalui runtime Codex native. Lihat Penyiapan penyedia OpenAI.

Catatan:

  • models set <model-or-alias> menerima provider/model atau alias.
  • models list bersifat hanya-baca: ia membaca konfigurasi, profil auth, status katalog yang ada, dan baris katalog milik penyedia, tetapi tidak menulis ulang models.json.
  • Kolom Auth berada di tingkat penyedia dan hanya-baca. Nilainya dihitung dari metadata profil auth lokal, penanda env, kunci penyedia yang dikonfigurasi, penanda penyedia lokal, penanda env/profil AWS Bedrock, dan metadata synthetic-auth Plugin; kolom ini tidak memuat runtime penyedia, membaca rahasia keychain, memanggil API penyedia, atau membuktikan kesiapan eksekusi persis per model.
  • models list --all --provider <id> dapat menyertakan baris katalog statis milik penyedia dari manifes Plugin atau metadata katalog penyedia bawaan meskipun Anda belum melakukan autentikasi dengan penyedia tersebut. Baris tersebut tetap ditampilkan sebagai tidak tersedia sampai auth yang cocok dikonfigurasi.
  • models list menjaga control plane tetap responsif saat penemuan katalog penyedia lambat. Tampilan default dan yang dikonfigurasi melakukan fallback ke baris model yang dikonfigurasi atau sintetis setelah waktu tunggu singkat dan membiarkan penemuan selesai di latar belakang. Gunakan --all saat Anda membutuhkan katalog lengkap hasil penemuan yang persis dan bersedia menunggu penemuan penyedia.
  • models list --all yang luas menggabungkan baris katalog manifes di atas baris registry tanpa memuat hook suplemen runtime penyedia. Jalur cepat manifes yang difilter penyedia hanya menggunakan penyedia yang ditandai static; penyedia yang ditandai refreshable tetap berbasis registry/cache dan menambahkan baris manifes sebagai suplemen, sedangkan penyedia yang ditandai runtime tetap menggunakan penemuan registry/runtime.
  • models list menjaga metadata model native dan batas runtime tetap terpisah. Dalam output tabel, Ctx menampilkan contextTokens/contextWindow saat batas runtime efektif berbeda dari jendela konteks native; baris JSON menyertakan contextTokens saat penyedia mengekspos batas tersebut.
  • models list --provider <id> memfilter berdasarkan id penyedia, seperti moonshot atau openai-codex. Perintah ini tidak menerima label tampilan dari pemilih penyedia interaktif, seperti Moonshot AI.
  • Referensi model diurai dengan membagi pada / pertama. Jika ID model menyertakan / (gaya OpenRouter), sertakan prefiks penyedia (contoh: openrouter/moonshotai/kimi-k2).
  • Jika Anda menghilangkan penyedia, OpenClaw me-resolve input sebagai alias terlebih dahulu, lalu sebagai kecocokan penyedia terkonfigurasi yang unik untuk id model persis tersebut, dan baru setelah itu melakukan fallback ke penyedia default yang dikonfigurasi dengan peringatan deprecasi. Jika penyedia tersebut tidak lagi mengekspos model default yang dikonfigurasi, OpenClaw melakukan fallback ke penyedia/model pertama yang dikonfigurasi alih-alih menampilkan default penyedia lama yang sudah dihapus.
  • models status dapat menampilkan marker(<value>) dalam output auth untuk placeholder non-rahasia (misalnya OPENAI_API_KEY, secretref-managed, minimax-oauth, oauth:chutes, ollama-local) alih-alih menyamarkannya sebagai rahasia.

Pemindaian model

models scan membaca katalog publik :free OpenRouter dan memberi peringkat kandidat untuk penggunaan fallback. Katalog itu sendiri bersifat publik, sehingga pemindaian hanya-metadata tidak membutuhkan kunci OpenRouter.

Secara default OpenClaw mencoba mem-probe dukungan alat dan gambar dengan panggilan model langsung. Jika tidak ada kunci OpenRouter yang dikonfigurasi, perintah melakukan fallback ke output hanya-metadata dan menjelaskan bahwa model :free tetap memerlukan OPENROUTER_API_KEY untuk probe dan inferensi.

Opsi:

  • --no-probe (hanya metadata; tanpa lookup konfigurasi/rahasia)
  • --min-params <b>
  • --max-age-days <days>
  • --provider <name>
  • --max-candidates <n>
  • --timeout <ms> (permintaan katalog dan timeout per probe)
  • --concurrency <n>
  • --yes
  • --no-input
  • --set-default
  • --set-image
  • --json

--set-default dan --set-image memerlukan probe langsung; hasil pemindaian hanya-metadata bersifat informasional dan tidak diterapkan ke konfigurasi.

Status model

Opsi:

  • --json
  • --plain
  • --check (exit 1=kedaluwarsa/hilang, 2=akan kedaluwarsa)
  • --probe (probe langsung profil auth yang dikonfigurasi)
  • --probe-provider <name> (probe satu penyedia)
  • --probe-profile <id> (id profil berulang atau dipisahkan koma)
  • --probe-timeout <ms>
  • --probe-concurrency <n>
  • --probe-max-tokens <n>
  • --agent <id> (id agen yang dikonfigurasi; menimpa OPENCLAW_AGENT_DIR/PI_CODING_AGENT_DIR)

--json menjaga stdout khusus untuk payload JSON. Diagnostik profil auth, penyedia, dan startup diarahkan ke stderr sehingga skrip dapat menyalurkan stdout langsung ke alat seperti jq.

Bucket status probe:

  • ok
  • auth
  • rate_limit
  • billing
  • timeout
  • format
  • unknown
  • no_model

Kasus detail/kode alasan probe yang perlu diantisipasi:

  • excluded_by_auth_order: profil tersimpan ada, tetapi auth.order.<provider> eksplisit menghilangkannya, sehingga probe melaporkan pengecualian tersebut alih-alih mencobanya.
  • missing_credential, invalid_expires, expired, unresolved_ref: profil ada tetapi tidak memenuhi syarat/dapat di-resolve.
  • no_model: auth penyedia ada, tetapi OpenClaw tidak dapat me-resolve kandidat model yang dapat di-probe untuk penyedia tersebut.

Alias + fallback

openclaw models aliases list
openclaw models fallbacks list

Profil auth

openclaw models auth add
openclaw models auth list [--provider <id>] [--json]
openclaw models auth login --provider <id>
openclaw models auth setup-token --provider <id>
openclaw models auth paste-token

models auth add adalah helper auth interaktif. Ia dapat meluncurkan alur auth penyedia (OAuth/kunci API) atau memandu Anda ke penempelan token manual, bergantung pada penyedia yang Anda pilih.

models auth list mencantumkan profil auth tersimpan untuk agen yang dipilih tanpa mencetak token, kunci API, atau materi rahasia OAuth. Gunakan --provider <id> untuk memfilter ke satu penyedia, seperti openai-codex, dan --json untuk scripting.

models auth login menjalankan alur auth Plugin penyedia (OAuth/kunci API). Gunakan openclaw plugins list untuk melihat penyedia mana yang terpasang. Gunakan openclaw models auth --agent <id> <subcommand> untuk menulis hasil auth ke store agen terkonfigurasi tertentu. Flag induk --agent dipatuhi oleh add, list, login, setup-token, paste-token, dan login-github-copilot.

Contoh:

openclaw models auth login --provider openai-codex --set-default
openclaw models auth list --provider openai-codex

Catatan:

  • setup-token dan paste-token tetap menjadi perintah token generik untuk penyedia yang mengekspos metode auth token.
  • setup-token memerlukan TTY interaktif dan menjalankan metode token-auth penyedia (default ke metode setup-token milik penyedia tersebut saat penyedia mengeksposnya).
  • paste-token menerima string token yang dibuat di tempat lain atau dari otomasi.
  • paste-token memerlukan --provider, meminta nilai token, dan menulisnya ke id profil default <provider>:manual kecuali Anda meneruskan --profile-id.
  • paste-token --expires-in <duration> menyimpan kedaluwarsa token absolut dari durasi relatif seperti 365d atau 12h.
  • Catatan Anthropic: staf Anthropic memberi tahu kami bahwa penggunaan Claude CLI bergaya OpenClaw diizinkan kembali, sehingga OpenClaw memperlakukan penggunaan ulang Claude CLI dan penggunaan claude -p sebagai disanksikan untuk integrasi ini kecuali Anthropic menerbitkan kebijakan baru.
  • Anthropic setup-token / paste-token tetap tersedia sebagai jalur token OpenClaw yang didukung, tetapi OpenClaw kini lebih memilih penggunaan ulang Claude CLI dan claude -p jika tersedia.

Terkait