CLI commands

CLI Workboard

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 dispatch [--board <id>] [--max-starts <count>] [--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 "Исправить устаревший Heartbeat рабочего процесса" --priority high --labels bug,workboardopenclaw workboard create "Написать документацию Workboard" --status ready --agent docs-agent --board docs --notes "Описать CLI, слеш-команду, отправку задач и состояние SQLite."
Флаг Назначение
--notes <text> Исходные заметки карточки
--status <status> Исходный статус, по умолчанию todo
--priority <priority> Приоритет, по умолчанию normal
--agent <id> Назначить карточку агенту или идентификатору владельца
--board <id> Сохранить карточку в пространстве имён доски
--labels <items> Метки, разделённые запятыми
--json Вывести созданную карточку в машиночитаемом формате JSON

create выполняет запись непосредственно в состояние SQLite Workboard. Карточка сразу становится видна на вкладке Workboard в Control UI и инструментам Workboard.

show

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

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

dispatch

bash
openclaw workboard dispatchopenclaw workboard dispatch --jsonopenclaw workboard dispatch --max-starts 10openclaw 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 агента по умолчанию.

Цикл отправки задач:

  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 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.

Устранение неполадок

Карточки не отображаются

Убедитесь, что плагин включён для того же профиля и корневого каталога состояния:

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