CLI commands
वर्कबोर्ड CLI
openclaw workboard बंडल किए गए Workboard Plugin के लिए टर्मिनल इंटरफ़ेस है। यह ऑपरेटर को कार्ड सूचीबद्ध करने, कार्ड बनाने, किसी एक कार्ड का निरीक्षण करने और चल रहे Gateway से तैयार कार्य को सबएजेंट वर्कर रन में डिस्पैच करने देता है।
कमांड का उपयोग करने से पहले Plugin सक्षम करें:
openclaw plugins enable workboardopenclaw gateway restartउपयोग
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 move <id> --status <status> [--json]openclaw workboard dispatch [--board <id>] [--max-starts <count>] [--admin] [--url <url>] [--token <token>] [--timeout <ms>] [--json]कमांड उसी Plugin-स्वामित्व वाले SQLite डेटाबेस को पढ़ता और लिखता है जिसका उपयोग डैशबोर्ड और Workboard एजेंट टूल करते हैं। कार्ड आईडी UUID होते हैं; कार्ड आईडी स्वीकार करने वाले कमांड स्पष्ट रूप से पहचाना जा सकने वाला आईडी उपसर्ग भी स्वीकार करते हैं (संक्षिप्त टेक्स्ट आउटपुट पहले 8 वर्ण दिखाता है)।
मान्य status मान: triage, backlog, todo, scheduled, ready, running, review, blocked, done। मान्य priority मान: low, normal, high, urgent।
list
openclaw workboard listopenclaw workboard list --board default --status readyopenclaw workboard list --jsonटेक्स्ट आउटपुट संक्षिप्त होता है:
7f4a2c10 ready high default agent-a पुराने वर्कर Heartbeat को ठीक करेंकॉलम क्रमशः आईडी उपसर्ग, स्थिति, प्राथमिकता, बोर्ड आईडी, वैकल्पिक एजेंट आईडी और शीर्षक हैं।
| फ़्लैग | उद्देश्य |
|---|---|
--board <id> |
परिणामों को एक बोर्ड नेमस्पेस तक सीमित करना |
--status <status> |
परिणामों को Workboard की एक स्थिति तक सीमित करना |
--include-archived |
संक्षिप्त टेक्स्ट आउटपुट में संग्रहीत कार्ड शामिल करना |
--json |
पूरी कार्ड सूची को मशीन JSON के रूप में प्रिंट करना |
संक्षिप्त टेक्स्ट आउटपुट डिफ़ॉल्ट रूप से संग्रहीत कार्ड छिपाता है, ताकि CLI /workboard list से मेल खाए। उन्हें दिखाने के लिए --include-archived दें। मौजूदा ऑटोमेशन के लिए JSON आउटपुट हमेशा संग्रहीत कार्ड सहित पूरी कार्ड सूची रखता है।
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."| फ़्लैग | उद्देश्य |
|---|---|
--notes <text> |
कार्ड के आरंभिक नोट्स |
--status <status> |
आरंभिक स्थिति, डिफ़ॉल्ट todo |
--priority <priority> |
प्राथमिकता, डिफ़ॉल्ट normal |
--agent <id> |
कार्ड को किसी एजेंट या स्वामी आईडी को असाइन करना |
--board <id> |
कार्ड को किसी बोर्ड नेमस्पेस में संग्रहीत करना |
--labels <items> |
कॉमा से अलग किए गए लेबल |
--json |
बनाए गए कार्ड को मशीन JSON के रूप में प्रिंट करना |
create सीधे Workboard की SQLite स्थिति में लिखता है। कार्ड Control UI के Workboard टैब और Workboard टूल में तुरंत दिखाई देता है।
show
openclaw workboard show 7f4a2c10openclaw workboard show 7f4a2c10 --jsonटेक्स्ट आउटपुट संक्षिप्त कार्ड पंक्ति और नोट्स प्रिंट करता है। JSON आउटपुट निष्पादन मेटाडेटा, प्रयासों, टिप्पणियों, लिंक, प्रमाण, आर्टिफ़ैक्ट, वर्कर लॉग, प्रोटोकॉल स्थिति, निदान और ऑटोमेशन मेटाडेटा सहित पूरा कार्ड रिकॉर्ड लौटाता है।
JSON में प्रमाण स्थितियाँ वर्कर द्वारा रिपोर्ट किए गए परिणाम हैं। passed संलग्न कमांड या जाँच के बारे में वर्कर का
स्व-मूल्यांकन दर्ज करता है; यह स्वतंत्र सत्यापन
परिणाम नहीं है।
move
openclaw workboard move 7f4a2c10 --status reviewopenclaw workboard move 7f4a2c10 --status done --jsonmove कार्ड की स्थिति को उसी मैन्युअल-ऑपरेटर पथ से बदलता है जिसका उपयोग डैशबोर्ड में कार्ड खींचने के लिए किया जाता है। यह पूरा कार्ड आईडी या स्पष्ट रूप से पहचाना जा सकने वाला उपसर्ग स्वीकार करता है। सक्रिय निर्भरता और शेड्यूल होल्ड अब भी लागू होते हैं। ऑपरेटर किसी क्लेम किए गए कार्ड को उसके एजेंट क्लेम टोकन के बिना स्थानांतरित कर सकते हैं; क्लेम टोकन एजेंट-टूल म्यूटेशन तक सीमित रहते हैं और JSON आउटपुट से संपादित कर दिए जाते हैं।
dispatch
openclaw workboard dispatchopenclaw workboard dispatch --jsonopenclaw workboard dispatch --max-starts 10openclaw workboard dispatch --adminopenclaw workboard dispatch --url http://127.0.0.1:18789 --token "$OPENCLAW_GATEWAY_TOKEN"dispatch पहले चल रहे Gateway की RPC विधि workboard.cards.dispatch को कॉल करता है, जो डैशबोर्ड की डिस्पैच कार्रवाई वाले उसी सबएजेंट रनटाइम का उपयोग करती है, इसलिए तैयार कार्ड लिंक की गई सत्र कुंजियों वाले कार्य-ट्रैक किए गए वर्कर रन बन जाते हैं। --max-starts अतिरिक्त workboard.cards.dispatchWithOptions विधि का उपयोग करता है, ताकि पुराना Gateway किसी वर्कर को शुरू करने से पहले विकल्प अस्वीकार कर दे; फ़्लैग का उपयोग करने से पहले अपग्रेड के बाद Gateway को रीस्टार्ट करें। असाइन किए गए एजेंट वाले कार्ड एजेंट-सीमित सबएजेंट सत्र कुंजियों का उपयोग करते हैं; बिना असाइन किए गए कार्ड असीमित सबएजेंट कुंजी रखते हैं, ताकि Gateway का कॉन्फ़िगर किया गया डिफ़ॉल्ट एजेंट सुरक्षित रहे।
डिस्पैच लूप:
- निर्भरता के अनुसार तैयार चाइल्ड को
readyमें पदोन्नत करता है। - समाप्त हो चुके क्लेम या समय-सीमा पार कर चुके वर्कर रन को ब्लॉक करता है।
- तैयार कार्ड पर डिस्पैच मेटाडेटा दर्ज करता है।
- बिना क्लेम वाले तैयार कार्ड का एक छोटा बैच चुनता है।
- प्रत्येक चयनित कार्ड को डिस्पैचर या असाइन किए गए एजेंट के लिए क्लेम करता है।
- सीमित कार्ड संदर्भ और कार्ड क्लेम टोकन के साथ सबएजेंट वर्कर रन शुरू करता है।
- कार्ड पर वर्कर रन आईडी, सत्र कुंजी, Gateway कार्य लेजर द्वारा रिपोर्ट किए जाने पर कार्य लिंकेज, निष्पादन स्थिति और वर्कर लॉग संग्रहीत करता है।
चयन रूढ़िवादी है: डिफ़ॉल्ट रूप से एक डिस्पैच अधिकतम तीन वर्कर शुरू करता है, संग्रहीत या पहले से क्लेम किए गए कार्ड छोड़ देता है और एक पास में प्रत्येक स्वामी या एजेंट के लिए केवल एक कार्ड शुरू करता है। सक्रिय रूप से चल रहे या समीक्षा वाले कार्य के स्वामित्व में पहले से मौजूद कार्ड बाद के डिस्पैच के लिए छोड़ दिए जाते हैं। प्रति-पास सीमा बदलने के लिए धनात्मक पूर्णांक के साथ --max-starts <count> दें; प्रति-स्वामी-एक-कार्ड नियम अब भी लागू होता है, इसलिए शुरू होने वाले वर्कर की प्रभावी संख्या कम हो सकती है।
कार्ड क्लेम होने के बाद वर्कर शुरू करने में विफलता होने पर, Workboard उस कार्ड को ब्लॉक करता है, क्लेम साफ़ करता है और कार्ड निष्पादन तथा वर्कर-लॉग मेटाडेटा में विफलता दर्ज करता है, जिससे विफल शुरुआत कार्ड को चुपचाप कतार में लौटाने के बजाय दिखाई देती रहती है।
यदि कोई स्पष्ट Gateway लक्ष्य नहीं दिया गया है और स्थानीय Gateway अनुपलब्ध है या अभी Workboard डिस्पैच विधि उपलब्ध नहीं कराता है, तो CLI स्थानीय Workboard स्थिति के विरुद्ध केवल-डेटा डिस्पैच पर फ़ॉलबैक करता है। केवल-डेटा डिस्पैच अब भी निर्भरताओं को पदोन्नत कर सकता है, पुराने क्लेम साफ़ कर सकता है और समय-सीमा पार कर चुके रन ब्लॉक कर सकता है, लेकिन यह वर्कर शुरू नहीं करता। प्रमाणीकरण, अनुमति और सत्यापन विफलताएँ तथा स्पष्ट --url या --token लक्ष्य की विफलताएँ फ़ॉलबैक ट्रिगर करने के बजाय सीधे रिपोर्ट की जाती हैं।
टेक्स्ट आउटपुट वर्कर की शुरुआत रिपोर्ट करता है:
डिस्पैच पूर्ण: शुरू=2 विफलताएँ=0फ़ॉलबैक आउटपुट स्पष्ट होता है:
Gateway अनुपलब्ध; केवल डेटा डिस्पैच: पदोन्नत=1 ब्लॉक=0JSON आउटपुट में डिस्पैच परिणाम शामिल होता है। Gateway-समर्थित डिस्पैच में started और startFailures शामिल हो सकते हैं; केवल-डेटा फ़ॉलबैक में gatewayUnavailable: true शामिल होता है। कार्ड JSON आउटपुट से क्लेम टोकन संपादित कर दिए जाते हैं।
डैशबोर्ड में यही डिस्पैच परिणाम एक संक्षिप्त सारांश के रूप में दिखाया जाता है, ताकि ऑपरेटर कार्ड विवरण खोले बिना देख सके कि कितने कार्ड शुरू, पदोन्नत, ब्लॉक, पुनः क्लेम या विफल हुए।
स्लैश कमांड समकक्षता
कमांड-समर्थ चैनल संगत स्लैश कमांड का उपयोग कर सकते हैं:
/workboard list/workboard show 7f4a2c10/workboard create पुराने वर्कर Heartbeat को ठीक करें/workboard move 7f4a2c10 --status review/workboard dispatchस्लैश कमांड डिस्पैच भी Gateway सबएजेंट रनटाइम का उपयोग करता है, इसलिए यह डैशबोर्ड और CLI Gateway पथ के समान क्लेम, वर्कर-आरंभ और विफलता व्यवहार का पालन करता है।
/workboard list और /workboard show अधिकृत कमांड प्रेषकों के लिए रीड कमांड हैं। /workboard create, /workboard move और /workboard dispatch बोर्ड स्थिति में बदलाव करते हैं और चैट इंटरफ़ेस पर स्वामी स्थिति या operator.write अथवा operator.admin वाले Gateway क्लाइंट की आवश्यकता होती है।
अनुमतियाँ
CLI डिस्पैच पथ सामान्यतः Gateway के operator.write और operator.read स्कोप का अनुरोध करता है। वर्कस्पेस से बँधे कार्ड सीधे सटीक कॉन्फ़िगर किए गए एजेंट वर्कस्पेस में चलते हैं; वर्कट्री अनुरोध को होस्ट द्वारा रिपॉज़िटरी-नियंत्रित कोड को मूर्त रूप देने की अनुमति देने के बजाय उसी डायरेक्टरी तक सीमित किया जाता है। चयनित वर्कर के पास उसी सटीक वर्कस्पेस के लिए लिखने योग्य, गैर-साझा Docker सैंडबॉक्स पहुँच, अनुरोधित माउंट और नीति से मेल खाने वाला सक्रिय कंटेनर हैश और होस्ट से बाहर निकलने की कोई क्षमता नहीं होनी चाहिए। स्पष्ट रूप से operator.admin का अनुरोध करने, किसी अन्य होस्ट चेकआउट को अनुमति देने और सामान्य प्रबंधित-वर्कट्री सेटअप का उपयोग करने के लिए --admin दें; यदि वह स्कोप क्लाइंट के लिए स्वीकृत नहीं है, तो कनेक्शन विफल हो जाता है। केवल-पढ़ने वाला Gateway टोकन रीड विधियों के माध्यम से Workboard डेटा का निरीक्षण कर सकता है, लेकिन कार्ड बना या वर्कर डिस्पैच नहीं कर सकता। Workboard म्यूटेशन अनुमति वाले कॉलर के लिए वर्कस्पेस सीमाएँ अन्यथा मैन्युअल कार्ड स्थानांतरण को नहीं बदलतीं।
स्थानीय list, create, show और move कमांड वर्तमान प्रोफ़ाइल द्वारा उपयोग की जाने वाली स्थानीय OpenClaw स्थिति डायरेक्टरी पर काम करते हैं। अलग स्थिति रूट की आवश्यकता होने पर शीर्ष-स्तरीय openclaw कमांड पर --dev या --profile <name> का उपयोग करें।
समस्या निवारण
कोई कार्ड दिखाई नहीं देता
पुष्टि करें कि Plugin उसी प्रोफ़ाइल और स्थिति रूट के लिए सक्षम है:
openclaw plugins inspect workboard --runtime --jsonयदि डैशबोर्ड कार्ड दिखाता है लेकिन CLI नहीं, तो जाँचें कि दोनों कमांड समान --dev या --profile सेटिंग का उपयोग करते हैं।
डिस्पैच केवल-डेटा बताता है
Gateway शुरू या रीस्टार्ट करें:
openclaw gateway restartopenclaw gateway status --deepफिर openclaw workboard dispatch को पुनः आज़माएँ। केवल-डेटा फ़ॉलबैक स्थानीय स्थिति की सफ़ाई के लिए उपयोगी है, लेकिन वर्कर रन के लिए सक्रिय Gateway आवश्यक है।
डिस्पैच कुछ भी शुरू नहीं करता
बिना सक्रिय क्लेम वाला कम से कम एक ready कार्ड होने की जाँच करें:
openclaw workboard list --status readyजब उसी स्वामी के पास पहले से चल रहा या समीक्षा वाला कार्य हो, तब भी कार्ड छोड़े जा सकते हैं। पूर्ण कार्य को done में ले जाएँ, Workboard टूल के माध्यम से पुराने क्लेम मुक्त करें या सक्रिय वर्कर के समाप्त होने के बाद डिस्पैच फिर चलाएँ।