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 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 в Control UI и инструментам 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 вызывает у работающего 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 move 7f4a2c10 --status review/workboard dispatch

Запуск через слеш-команду также использует среду выполнения субагентов Gateway, поэтому закрепление, запуск рабочих процессов и обработка ошибок выполняются так же, как при запуске через панель управления и путь Gateway в CLI.

/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