CLI commands

CLI de Workboard

openclaw workboard es la interfaz de terminal del Plugin Workboard incluido. Permite a un operador enumerar tarjetas, crear una tarjeta, inspeccionar una tarjeta y solicitar al Gateway en ejecución que despache el trabajo listo a ejecuciones de subagentes trabajadores.

Active el Plugin antes de usar el comando:

bash
openclaw plugins enable workboardopenclaw gateway restart

Uso

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]

El comando lee y escribe en la misma base de datos SQLite propiedad del Plugin que utilizan el panel y las herramientas del agente Workboard. Los identificadores de tarjeta son UUID; los comandos que aceptan un identificador de tarjeta también aceptan un prefijo de identificador inequívoco (la salida de texto compacta muestra los primeros 8 caracteres).

Valores válidos de status: triage, backlog, todo, scheduled, ready, running, review, blocked, done. Valores válidos de priority: low, normal, high, urgent.

list

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

La salida de texto es compacta:

text
7f4a2c10  ready     high    default agent-a  Corregir el Heartbeat obsoleto del trabajador

Las columnas son el prefijo del identificador, el estado, la prioridad, el identificador del tablero, el identificador opcional del agente y el título.

Indicador Finalidad
--board <id> Limitar los resultados a un espacio de nombres de tablero
--status <status> Limitar los resultados a un estado de Workboard
--include-archived Incluir tarjetas archivadas en la salida de texto compacta
--json Imprimir la lista completa de tarjetas como JSON para máquinas

La salida de texto compacta oculta de forma predeterminada las tarjetas archivadas para que la CLI coincida con /workboard list. Pase --include-archived para mostrarlas. La salida JSON siempre conserva la lista completa de tarjetas, incluidas las archivadas, para la automatización existente.

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."
Indicador Finalidad
--notes <text> Notas iniciales de la tarjeta
--status <status> Estado inicial, valor predeterminado todo
--priority <priority> Prioridad, valor predeterminado normal
--agent <id> Asignar la tarjeta a un agente o identificador de propietario
--board <id> Almacenar la tarjeta en un espacio de nombres de tablero
--labels <items> Etiquetas separadas por comas
--json Imprimir la tarjeta creada como JSON para máquinas

create escribe directamente en el estado SQLite de Workboard. La tarjeta aparece inmediatamente en la pestaña Workboard de la interfaz de control y para las herramientas de Workboard.

show

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

La salida de texto imprime la línea compacta de la tarjeta y las notas. La salida JSON devuelve el registro completo de la tarjeta, incluidos los metadatos de ejecución, los intentos, los comentarios, los enlaces, las pruebas, los artefactos, los registros del trabajador, el estado del protocolo, los diagnósticos y los metadatos de automatización.

Los estados de las pruebas en JSON son resultados informados por el trabajador. passed registra la autoevaluación del trabajador sobre el comando o la comprobación adjuntos; no es un resultado de verificación independiente.

move

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

move cambia el estado de la tarjeta mediante la misma ruta del operador manual que se utiliza al arrastrar una tarjeta en el panel. Acepta un identificador de tarjeta completo o un prefijo inequívoco. Las retenciones activas por dependencias y programación siguen aplicándose. Los operadores pueden mover una tarjeta reclamada sin el token de reclamación de su agente; los tokens de reclamación siguen limitados a las mutaciones de las herramientas del agente y se ocultan en la salida 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 llama primero al método RPC workboard.cards.dispatch del Gateway en ejecución, que utiliza el mismo entorno de ejecución de subagentes que la acción de despacho del panel, de modo que las tarjetas listas se convierten en ejecuciones de trabajadores con seguimiento de tareas y claves de sesión vinculadas. --max-starts utiliza el método aditivo workboard.cards.dispatchWithOptions para que un Gateway antiguo rechace la opción antes de iniciar cualquier trabajador; reinicie el Gateway después de actualizarlo antes de usar el indicador. Las tarjetas con un agente asignado utilizan claves de sesión de subagente limitadas al agente; las tarjetas sin asignar conservan una clave de subagente sin ámbito para preservar el agente predeterminado configurado del Gateway.

El bucle de despacho:

  1. Promueve a ready los elementos secundarios cuyas dependencias están listas.
  2. Bloquea las reclamaciones vencidas o las ejecuciones de trabajadores que han agotado el tiempo de espera.
  3. Registra los metadatos de despacho en las tarjetas listas.
  4. Selecciona un pequeño lote de tarjetas listas sin reclamar.
  5. Reclama cada tarjeta seleccionada para el despachador o el agente asignado.
  6. Inicia una ejecución de trabajador subagente con un contexto de tarjeta limitado y el token de reclamación de la tarjeta.
  7. Almacena en la tarjeta el identificador de ejecución del trabajador, la clave de sesión, la vinculación de tareas cuando el registro de tareas del Gateway la informa, el estado de ejecución y el registro del trabajador.

La selección es conservadora: de forma predeterminada, un despacho inicia como máximo tres trabajadores, omite las tarjetas archivadas o ya reclamadas e inicia solo una tarjeta por propietario o agente en una misma pasada. Las tarjetas que ya pertenecen a trabajo activo en ejecución o revisión se dejan para un despacho posterior. Pase --max-starts <count> con un entero positivo para cambiar el límite por pasada; la regla de una tarjeta por propietario sigue aplicándose, por lo que el número efectivo de inicios puede ser menor.

Si el inicio del trabajador falla después de que se haya reclamado una tarjeta, Workboard bloquea esa tarjeta, elimina la reclamación y registra el fallo en los metadatos de ejecución y del registro del trabajador de la tarjeta, lo que mantiene visibles los inicios fallidos en lugar de devolver silenciosamente la tarjeta a la cola.

Si no se proporciona un destino de Gateway explícito y el Gateway local no está disponible o aún no expone el método de despacho de Workboard, la CLI recurre al despacho solo de datos contra el estado local de Workboard. El despacho solo de datos todavía puede promover dependencias, limpiar reclamaciones obsoletas y bloquear ejecuciones que han agotado el tiempo de espera, pero no inicia trabajadores. Los fallos de autenticación, permisos y validación, así como los fallos de un destino --url o --token explícito, se notifican directamente en lugar de activar el mecanismo alternativo.

La salida de texto informa de los inicios de trabajadores:

text
despacho completado: iniciados=2 fallos=0

La salida del mecanismo alternativo es explícita:

text
Gateway no disponible; solo despacho de datos: promovidas=1 bloqueadas=0

La salida JSON incluye el resultado del despacho. El despacho respaldado por el Gateway puede incluir started y startFailures; el mecanismo alternativo solo de datos incluye gatewayUnavailable: true. Los tokens de reclamación se ocultan en la salida JSON de las tarjetas.

En el panel, el mismo resultado del despacho se muestra como un breve resumen para que el operador pueda ver cuántas tarjetas se iniciaron, promovieron, bloquearon, recuperaron o fallaron sin abrir los detalles de las tarjetas.

Paridad de comandos con barra diagonal

Los canales compatibles con comandos pueden utilizar el comando con barra diagonal correspondiente:

text
/workboard list/workboard show 7f4a2c10/workboard create Corregir el Heartbeat obsoleto del trabajador/workboard move 7f4a2c10 --status review/workboard dispatch

El despacho mediante comandos con barra diagonal también utiliza el entorno de ejecución de subagentes del Gateway, por lo que sigue el mismo comportamiento de reclamación, inicio de trabajadores y fallos que el panel y la ruta de Gateway de la CLI.

/workboard list y /workboard show son comandos de lectura para remitentes de comandos autorizados. /workboard create, /workboard move y /workboard dispatch modifican el estado del tablero y requieren la condición de propietario en las interfaces de chat o un cliente del Gateway con operator.write o operator.admin.

Permisos

La ruta de despacho de la CLI normalmente solicita los ámbitos operator.write y operator.read del Gateway. Las tarjetas vinculadas a un espacio de trabajo se ejecutan directamente en un espacio de trabajo exacto de un agente configurado; una solicitud de árbol de trabajo se limita a ese directorio en lugar de permitir que el host materialice código controlado por el repositorio. El trabajador seleccionado debe tener acceso de escritura al entorno aislado de Docker, sin uso compartido, para ese espacio de trabajo exacto, un hash de contenedor activo que coincida con los montajes y la política solicitados, y ninguna capacidad de escape al host. Pase --admin para solicitar explícitamente operator.admin, permitir otro checkout del host y utilizar la configuración normal del árbol de trabajo administrado; la conexión falla si ese ámbito no está aprobado para el cliente. Un token del Gateway de solo lectura puede inspeccionar los datos de Workboard mediante métodos de lectura, pero no puede crear tarjetas ni despachar trabajadores. Por lo demás, los límites del espacio de trabajo no modifican el movimiento manual de tarjetas para los invocadores que tengan permiso de modificación de Workboard.

Los comandos locales list, create, show y move operan en el directorio de estado local de OpenClaw utilizado por el perfil actual. Use --dev o --profile <name> en el comando openclaw de nivel superior cuando necesite una raíz de estado diferente.

Solución de problemas

No aparece ninguna tarjeta

Confirme que el Plugin esté activado para el mismo perfil y la misma raíz de estado:

bash
openclaw plugins inspect workboard --runtime --json

Si el panel muestra tarjetas pero la CLI no, compruebe que ambos comandos utilicen la misma configuración --dev o --profile.

El despacho indica que es solo de datos

Inicie o reinicie el Gateway:

bash
openclaw gateway restartopenclaw gateway status --deep

A continuación, vuelva a intentar openclaw workboard dispatch. El mecanismo alternativo solo de datos es útil para limpiar el estado local, pero las ejecuciones de trabajadores necesitan un Gateway activo.

El despacho no inicia nada

Compruebe que haya al menos una tarjeta ready sin una reclamación activa:

bash
openclaw workboard list --status ready

Las tarjetas también pueden omitirse cuando el mismo propietario ya tiene trabajo en ejecución o revisión. Mueva el trabajo completado a done, libere las reclamaciones obsoletas mediante las herramientas de Workboard o vuelva a ejecutar el despacho cuando termine el trabajador activo.

Contenido relacionado

Was this useful?
On this page

On this page