CLI commands
CLI Papan Kerja
openclaw workboard adalah permukaan terminal untuk Plugin Workboard
bawaan. Perintah ini memungkinkan operator mencantumkan kartu, membuat kartu,
memeriksa satu kartu, dan meminta Gateway yang sedang berjalan untuk
mengirimkan pekerjaan siap ke run pekerja subagen.
Aktifkan Plugin sebelum menggunakan perintah:
openclaw plugins enable workboardopenclaw gateway restartPenggunaan
openclaw workboard list [--board <id>] [--status <status>] [--include-archived] [--json]openclaw workboard create <title...> [--notes <text>] [--status <status>] [--priority <priority>] [--agent <id>] [--board <id>] [--labels <items>] [--json]openclaw workboard show <id> [--json]openclaw workboard dispatch [--url <url>] [--token <token>] [--timeout <ms>] [--json]Perintah ini membaca dan menulis database SQLite milik Plugin yang sama yang digunakan oleh dasbor dan alat agen Workboard. Id kartu dapat diteruskan sebagai id lengkap atau sebagai prefiks yang tidak ambigu saat sebuah perintah menerima id kartu.
list
openclaw workboard listopenclaw workboard list --board default --status readyopenclaw workboard list --jsonOutput teks bersifat ringkas:
7f4a2c10 ready high default agent-a Fix stale worker heartbeatKolomnya adalah prefiks id, status, prioritas, id board, id agen opsional, dan judul.
Flag:
| Flag | Tujuan |
|---|---|
--board <id> |
Batasi hasil ke satu namespace board |
--status <status> |
Batasi hasil ke satu status Workboard |
--include-archived |
Sertakan kartu yang diarsipkan dalam output ringkas |
--json |
Cetak daftar kartu lengkap sebagai JSON mesin |
Output teks ringkas menyembunyikan kartu yang diarsipkan secara default agar CLI
sesuai dengan perintah /workboard list. Teruskan --include-archived untuk
menampilkannya. Output JSON mempertahankan daftar kartu lengkap, termasuk kartu
yang diarsipkan, untuk otomatisasi yang sudah ada.
create
openclaw workboard create "Fix stale worker heartbeat" --priority high --labels bug,workboardopenclaw workboard create "Write Workboard docs" --status ready --agent docs-agent --board docs --notes "Cover CLI, slash command, dispatch, and SQLite state."Flag:
| Flag | Tujuan |
|---|---|
--notes <text> |
Catatan awal kartu |
--status <status> |
Status awal, default todo |
--priority <priority> |
Prioritas, default normal |
--agent <id> |
Tetapkan kartu ke agen atau id pemilik |
--board <id> |
Simpan kartu pada namespace board |
--labels <items> |
Label yang dipisahkan koma |
--json |
Cetak kartu yang dibuat sebagai JSON mesin |
create menulis langsung ke status SQLite Workboard. Kartu langsung terlihat di
tab Workboard Control UI dan bagi alat Workboard.
show
openclaw workboard show 7f4a2c10openclaw workboard show 7f4a2c10 --jsonOutput teks mencetak baris kartu ringkas dan catatan. Output JSON mengembalikan rekaman kartu lengkap, termasuk metadata eksekusi, percobaan, komentar, tautan, bukti, artefak, log pekerja, status protokol, diagnostik, dan metadata otomatisasi.
dispatch
openclaw workboard dispatchopenclaw workboard dispatch --jsonopenclaw workboard dispatch --url http://127.0.0.1:18789 --token "$OPENCLAW_GATEWAY_TOKEN"dispatch terlebih dahulu memanggil metode RPC Gateway yang sedang berjalan
workboard.cards.dispatch. Jalur tersebut menggunakan runtime subagen yang sama
seperti tindakan dispatch dasbor, sehingga kartu siap menjadi run pekerja yang
dilacak tugas dengan kunci sesi tertaut. Kartu dengan agen yang ditetapkan
menggunakan kunci sesi subagen bercakupan agen; kartu tanpa penetapan
mempertahankan kunci subagen tanpa cakupan sehingga agen default yang
dikonfigurasi Gateway tetap dipertahankan.
Loop dispatch:
- Mempromosikan turunan yang dependensinya siap menjadi
ready. - Memblokir klaim yang kedaluwarsa atau run pekerja yang timeout.
- Merekam metadata dispatch pada kartu siap.
- Memilih batch kecil kartu siap yang belum diklaim.
- Mengklaim setiap kartu yang dipilih untuk dispatcher atau agen yang ditetapkan.
- Memulai run pekerja subagen dengan konteks kartu terbatas dan token klaim kartu.
- Menyimpan id run pekerja, kunci sesi, penautan tugas saat ledger tugas Gateway melaporkannya, status eksekusi, dan log pekerja pada kartu.
Pemilihan sengaja dibuat konservatif. Satu dispatch memulai paling banyak tiga pekerja secara default, melewati kartu yang diarsipkan atau sudah diklaim, dan hanya memulai satu kartu per pemilik atau agen dalam satu lintasan. Kartu yang sudah dimiliki oleh pekerjaan aktif yang sedang berjalan atau sedang ditinjau ditinggalkan untuk dispatch berikutnya.
Jika start pekerja gagal setelah kartu diklaim, Workboard memblokir kartu tersebut, menghapus klaim, dan mencatat kegagalan dalam metadata eksekusi kartu dan log pekerja. Ini membuat start yang gagal tetap terlihat alih-alih diam-diam mengembalikan kartu ke antrean.
Jika tidak ada target Gateway eksplisit yang diberikan dan Gateway lokal tidak
tersedia atau belum mengekspos metode dispatch Workboard, CLI beralih ke dispatch
khusus data terhadap status Workboard lokal. Dispatch khusus data masih dapat
mempromosikan dependensi, membersihkan klaim usang, dan memblokir run yang
timeout, tetapi tidak memulai pekerja. Kegagalan autentikasi, izin, validasi,
serta kegagalan untuk target --url atau --token eksplisit dilaporkan secara
langsung.
Output teks melaporkan start pekerja:
dispatch complete: started=2 failures=0Output fallback bersifat eksplisit:
gateway unavailable; data dispatch only: promoted=1 blocked=0Output JSON menyertakan hasil dispatch. Dispatch yang didukung Gateway dapat
menyertakan started dan startFailures; fallback khusus data menyertakan
gatewayUnavailable: true. Token klaim disamarkan dari output JSON kartu.
Di dasbor, hasil dispatch yang sama ditampilkan sebagai ringkasan pendek sehingga operator dapat melihat berapa banyak kartu yang dimulai, dipromosikan, diblokir, direklaim, atau gagal tanpa membuka detail kartu.
Kesetaraan Perintah Slash
Channel yang mendukung perintah dapat menggunakan perintah slash yang sesuai:
/workboard list/workboard show 7f4a2c10/workboard create Fix stale worker heartbeat/workboard dispatchDispatch perintah slash juga menggunakan runtime subagen Gateway, sehingga mengikuti perilaku klaim, start pekerja, dan kegagalan yang sama seperti jalur Gateway dasbor dan CLI.
/workboard list dan /workboard show adalah perintah baca untuk pengirim
perintah yang berwenang. /workboard create dan /workboard dispatch mengubah
status board dan memerlukan status pemilik pada permukaan chat atau klien Gateway
dengan operator.write atau operator.admin.
Izin
Jalur dispatch CLI memanggil RPC Gateway dengan cakupan operator.read dan
operator.write. Token Gateway hanya-baca dapat memeriksa data Workboard melalui
metode baca, tetapi tidak dapat membuat kartu atau mengirimkan pekerja.
Perintah lokal list, create, dan show beroperasi pada direktori status
OpenClaw lokal yang digunakan oleh profil saat ini. Gunakan --dev atau
--profile <name> pada perintah openclaw tingkat atas saat Anda memerlukan
root status yang berbeda.
Pemecahan Masalah
Tidak Ada Kartu yang Muncul
Pastikan Plugin diaktifkan untuk profil dan root status yang sama:
openclaw plugins inspect workboard --runtime --jsonJika dasbor menampilkan kartu tetapi CLI tidak, periksa bahwa kedua perintah
menggunakan pengaturan --dev atau --profile yang sama.
Dispatch Mengatakan Khusus Data
Mulai atau mulai ulang Gateway:
openclaw gateway restartopenclaw gateway status --deepLalu coba lagi openclaw workboard dispatch. Fallback khusus data berguna untuk
pembersihan status lokal, tetapi run pekerja memerlukan Gateway yang aktif.
Dispatch Tidak Memulai Apa Pun
Periksa setidaknya ada satu kartu ready tanpa klaim aktif:
openclaw workboard list --status readyKartu juga dapat dilewati saat pemilik yang sama sudah memiliki pekerjaan yang
sedang berjalan atau sedang ditinjau. Pindahkan pekerjaan selesai ke done,
lepaskan klaim usang melalui alat Workboard, atau jalankan dispatch lagi setelah
pekerja aktif selesai.