CLI commands
CLI робочої дошки
openclaw workboard — це термінальний інтерфейс для вбудованого Plugin Workboard. Він дає оператору змогу переглядати список карток, створювати картку, переглядати окрему картку та доручати запущеному 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 dispatch [--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 Fix stale worker 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. Картка одразу стає видимою на вкладці Workboard в Control UI та для інструментів Workboard.
show
openclaw workboard show 7f4a2c10openclaw workboard show 7f4a2c10 --jsonТекстове виведення містить компактний рядок картки та нотатки. Виведення JSON повертає повний запис картки, включно з метаданими виконання, спробами, коментарями, посиланнями, підтвердженнями, артефактами, журналами виконавця, станом протоколу, діагностикою та метаданими автоматизації.
dispatch
openclaw workboard dispatchopenclaw workboard dispatch --jsonopenclaw workboard dispatch --url http://127.0.0.1:18789 --token "$OPENCLAW_GATEWAY_TOKEN"dispatch спочатку викликає метод RPC запущеного Gateway workboard.cards.dispatch, який використовує те саме середовище виконання підлеглих агентів, що й дія передавання роботи на панелі керування. Завдяки цьому готові картки стають відстежуваними завданнями запусків виконавців із пов’язаними ключами сеансів. Картки з призначеним агентом використовують ключі сеансів підлеглих агентів у межах цього агента; непризначені картки зберігають ключ підлеглого агента без визначеної області, щоб не змінювати налаштованого в Gateway агента за замовчуванням.
Цикл передавання роботи:
- Переводить дочірні картки з виконаними залежностями в стан
ready. - Блокує прострочені заявки або запуски виконавців, час очікування яких минув.
- Записує метадані передавання роботи в готові картки.
- Вибирає невелику групу незаявлених готових карток.
- Закріплює кожну вибрану картку за диспетчером або призначеним агентом.
- Запускає підлеглого агента-виконавця з обмеженим контекстом картки та токеном заявки картки.
- Зберігає в картці ідентифікатор запуску виконавця, ключ сеансу, зв’язок із завданням, якщо його повідомляє реєстр завдань Gateway, статус виконання та журнал виконавця.
Вибір є консервативним: за замовчуванням одне передавання запускає не більше трьох виконавців, пропускає архівовані або вже заявлені картки та за один прохід запускає лише одну картку на власника чи агента. Картки, уже закріплені за активною роботою зі статусом виконання або перевірки, залишаються для наступного передавання.
Якщо після закріплення картки запуск виконавця завершується помилкою, Workboard блокує цю картку, знімає закріплення та записує помилку до метаданих виконання картки й журналу виконавця. Так невдалі запуски залишаються видимими, а картка не повертається до черги без повідомлення.
Якщо явну ціль Gateway не вказано, а локальний Gateway недоступний або ще не надає метод передавання Workboard, CLI переходить до передавання лише даних, використовуючи локальний стан Workboard. Передавання лише даних усе ще може переводити картки з виконаними залежностями в готовий стан, очищати застарілі закріплення та блокувати запуски, час очікування яких минув, але не запускає виконавців. Про помилки автентифікації, дозволів і перевірки, а також про помилки для явно заданої цілі --url або --token повідомляється безпосередньо, без переходу до резервного режиму.
Текстове виведення повідомляє про запуски виконавців:
dispatch complete: started=2 failures=0Виведення в резервному режимі є явним:
gateway unavailable; data dispatch only: promoted=1 blocked=0Виведення JSON містить результат передавання роботи. Передавання через Gateway може містити started і startFailures; резервний режим лише для даних містить gatewayUnavailable: true. Токени заявок приховуються у виведенні JSON карток.
На панелі керування той самий результат передавання роботи показано як коротке зведення, щоб оператор міг побачити кількість запущених, переведених у готовий стан, заблокованих, повторно закріплених або невдалих карток, не відкриваючи їхні подробиці.
Відповідність командам із косою рискою
Канали з підтримкою команд можуть використовувати відповідну команду з косою рискою:
/workboard list/workboard show 7f4a2c10/workboard create Fix stale worker heartbeat/workboard dispatchПередавання роботи через команду з косою рискою також використовує середовище виконання підлеглих агентів Gateway, тому має таку саму поведінку щодо закріплення, запуску виконавця та помилок, як панель керування і шлях CLI через Gateway.
/workboard list і /workboard show — це команди читання для авторизованих відправників команд. /workboard create і /workboard dispatch змінюють стан дошки та в інтерфейсах чату потребують статусу власника або клієнта Gateway з operator.write чи operator.admin.
Дозволи
Шлях передавання роботи через CLI викликає RPC Gateway з областями доступу operator.read і operator.write. Токен Gateway лише для читання може переглядати дані Workboard через методи читання, але не може створювати картки або запускати виконавців.
Локальні команди list, create і show працюють із локальним каталогом стану OpenClaw, який використовує поточний профіль. Якщо потрібен інший кореневий каталог стану, використовуйте --dev або --profile <name> у команді верхнього рівня openclaw.
Усунення несправностей
Картки не відображаються
Переконайтеся, що 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 або повторно запустіть передавання після завершення роботи активного виконавця.
