CLI commands

CLI робочої дошки

openclaw workboard — це термінальний інтерфейс для вбудованого плагіна Workboard. Він дає оператору змогу переглядати список карток, створювати картку, переглядати окрему картку та доручати запущеному Gateway передавати готову роботу підлеглим агентам-виконавцям.

Перед використанням команди ввімкніть плагін:

bash
openclaw plugins enable workboardopenclaw gateway restart

Використання

bash
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]

Команда читає та записує ту саму базу даних SQLite, що належить плагіну й використовується панеллю керування та інструментами агента Workboard. Ідентифікатори карток — це UUID; команди, які приймають ідентифікатор картки, також приймають його однозначний префікс (у стислому текстовому виведенні показано перші 8 символів).

Допустимі значення status: triage, backlog, todo, scheduled, ready, running, review, blocked, done. Допустимі значення priority: low, normal, high, urgent.

list

bash
openclaw workboard listopenclaw workboard list --board default --status readyopenclaw workboard list --json

Текстове виведення стисле:

text
7f4a2c10  ready     high    default agent-a  Виправити застарілий Heartbeat виконавця

Стовпці: префікс ідентифікатора, статус, пріоритет, ідентифікатор дошки, необов’язковий ідентифікатор агента та заголовок.

Прапорець Призначення
--board <id> Обмежити результати одним простором імен дошки
--status <status> Обмежити результати одним статусом Workboard
--include-archived Додати архівовані картки до стислого текстового виведення
--json Вивести повний список карток у машинному форматі JSON

Стисле текстове виведення за замовчуванням приховує архівовані картки, щоб CLI відповідав /workboard list. Щоб показати їх, передайте --include-archived. Виведення JSON завжди містить повний список карток, включно з архівованими, для наявної автоматизації.

create

bash
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 записує безпосередньо до стану SQLite Workboard. Картка одразу з’являється на вкладці Workboard в інтерфейсі керування та стає доступною інструментам Workboard.

show

bash
openclaw workboard show 7f4a2c10openclaw workboard show 7f4a2c10 --json

Текстове виведення містить стислий рядок картки та примітки. Виведення JSON повертає повний запис картки, включно з метаданими виконання, спробами, коментарями, посиланнями, доказами, артефактами, журналами виконавця, станом протоколу, діагностикою та метаданими автоматизації.

move

bash
openclaw workboard move 7f4a2c10 --status reviewopenclaw workboard move 7f4a2c10 --status done --json

move змінює статус картки тим самим шляхом ручних дій оператора, що й перетягування картки на панелі керування. Команда приймає повний ідентифікатор картки або його однозначний префікс. Активні блокування через залежності та розклад усе одно діють. Оператори можуть переміщувати зарезервовану картку без токена резервування агента; токени резервування й надалі застосовуються лише до змін через інструменти агента та вилучаються з виведення JSON.

dispatch

bash
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 спочатку викликає метод RPC workboard.cards.dispatch запущеного Gateway, який використовує те саме середовище виконання підлеглих агентів, що й дія передавання на панелі керування, тому готові картки стають відстежуваними завданнями запусків виконавців із пов’язаними ключами сеансів. --max-starts використовує додатковий метод workboard.cards.dispatchWithOptions, тому старіший Gateway відхиляє параметр до запуску будь-яких виконавців; після оновлення перезапустіть Gateway, перш ніж використовувати прапорець. Картки з призначеним агентом використовують ключі сеансів підлеглих агентів у межах цього агента; непризначені картки зберігають ключ підлеглого агента без прив’язки, щоб зберегти налаштованого в Gateway агента за замовчуванням.

Цикл передавання:

  1. Переводить дочірні картки з виконаними залежностями до ready.
  2. Блокує прострочені резервування або запуски виконавців, для яких минув час очікування.
  3. Записує метадані передавання в готових картках.
  4. Вибирає невеликий пакет незарезервованих готових карток.
  5. Резервує кожну вибрану картку за диспетчером або призначеним агентом.
  6. Запускає підлеглого агента-виконавця з обмеженим контекстом картки та токеном її резервування.
  7. Зберігає в картці ідентифікатор запуску виконавця, ключ сеансу, зв’язок із завданням, якщо його повідомляє реєстр завдань Gateway, статус виконання та журнал виконавця.

Вибір консервативний: за замовчуванням одне передавання запускає щонайбільше трьох виконавців, пропускає архівовані або вже зарезервовані картки й запускає лише одну картку для кожного власника або агента за один прохід. Картки, які вже належать активній роботі зі статусом виконання або перевірки, залишаються до наступного передавання. Передайте --max-starts <count> із додатним цілим числом, щоб змінити обмеження на один прохід; правило однієї картки на власника все одно діє, тому фактична кількість запусків може бути меншою.

Якщо запуск виконавця завершується помилкою після резервування картки, Workboard блокує цю картку, скасовує резервування та записує помилку в метадані виконання картки й журнал виконавця, щоб невдалі запуски залишалися видимими, а картка не поверталася до черги без повідомлення.

Якщо явну ціль Gateway не вказано, а локальний Gateway недоступний або ще не надає метод передавання Workboard, CLI переходить до передавання лише даних у локальному стані Workboard. Передавання лише даних усе ще може переводити картки після виконання залежностей, очищати застарілі резервування та блокувати запуски, для яких минув час очікування, але не запускає виконавців. Помилки автентифікації, дозволів і перевірки, а також помилки для явно заданої цілі --url або --token повідомляються безпосередньо, а не запускають резервний режим.

Текстове виведення повідомляє про запуски виконавців:

text
передавання завершено: запущено=2 помилок=0

Виведення резервного режиму однозначне:

text
gateway недоступний; лише передавання даних: переведено=1 заблоковано=0

Виведення JSON містить результат передавання. Передавання через Gateway може містити started і startFailures; резервний режим лише даних містить gatewayUnavailable: true. Токени резервування вилучаються з виведення JSON картки.

На панелі керування той самий результат передавання відображається як коротке зведення, щоб оператор міг побачити, скільки карток запущено, переведено, заблоковано, повторно зарезервовано або завершилося помилкою, не відкриваючи відомості карток.

Відповідність команд із косою рискою

Канали з підтримкою команд можуть використовувати відповідну команду з косою рискою:

text
/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 змінюють стан дошки та потребують статусу власника в чатах або клієнта Gateway із operator.write чи operator.admin.

Дозволи

Шлях передавання CLI зазвичай запитує області дозволів Gateway operator.write і operator.read. Картки, прив’язані до робочого простору, виконуються безпосередньо в точно налаштованому робочому просторі агента; запит на робоче дерево обмежується цим каталогом, замість того щоб дозволяти хосту розгортати код, керований репозиторієм. Вибраний виконавець повинен мати доступ до записуваної, неспільної пісочниці Docker саме для цього робочого простору, актуальний хеш контейнера, що відповідає запитаним монтуванням і політиці, та не мати можливості виходу на хост. Передайте --admin, щоб явно запросити operator.admin, дозволити інше робоче дерево хоста та використати звичайне налаштування керованого робочого дерева; з’єднання завершиться помилкою, якщо цю область дозволів не схвалено для клієнта. Токен Gateway лише для читання може переглядати дані Workboard за допомогою методів читання, але не може створювати картки або передавати роботу виконавцям. Обмеження робочого простору не впливають на ручне переміщення карток для викликачів із дозволом на зміну Workboard.

Локальні команди list, create, show і move працюють із локальним каталогом стану OpenClaw, який використовує поточний профіль. Якщо потрібен інший корінь стану, використовуйте --dev або --profile <name> у команді верхнього рівня openclaw.

Усунення несправностей

Картки не відображаються

Переконайтеся, що плагін увімкнено для того самого профілю й кореня стану:

bash
openclaw plugins inspect workboard --runtime --json

Якщо панель керування показує картки, а CLI — ні, перевірте, чи обидві команди використовують однакове налаштування --dev або --profile.

Передавання повідомляє про режим лише даних

Запустіть або перезапустіть Gateway:

bash
openclaw gateway restartopenclaw gateway status --deep

Потім повторіть openclaw workboard dispatch. Резервний режим лише даних корисний для очищення локального стану, але для запуску виконавців потрібен активний Gateway.

Передавання нічого не запускає

Перевірте наявність принаймні однієї картки ready без активного резервування:

bash
openclaw workboard list --status ready

Картки також можуть пропускатися, якщо той самий власник уже має роботу зі статусом виконання або перевірки. Перемістіть завершену роботу до done, скасуйте застарілі резервування за допомогою інструментів Workboard або повторіть передавання після завершення роботи активного виконавця.

Пов’язані матеріали

Was this useful?
On this page

On this page