Referencia: elyra workspace list

elyra workspace list

Enumera los workspaces de Elyra. Un workspace es un nombre y una carpeta dentro de un proyecto — no es un worktree de git. Los worktrees de git pertenecen a git y aparecen en la pantalla Git; este comando nunca los enumera.

elyra workspace list [--repo <selector>] [--limit <n>] [--json]

Flags aceptadas por el registro de la CLI: --help, --json, --pairing-code, --environment, --repo, --limit.

Antes de ejecutar

• La app tiene que estar en marcha. El comando consulta el runtime de la app; con la app cerrada, la CLI devuelve runtime_unavailable y Could not read Elyra runtime metadata at <perfil>/elyra-runtime.json. Start the Elyra app first.. elyra agent-context --json lee el registro local y funciona con la app cerrada.
• Usa la CLI de la instalación activa. command -v elyra muestra el ejecutable del PATH. Ejecuta el comando en la terminal del proyecto abierto en la app. La misma petición desde un shell externo se rechaza con agent_operation_denied/invalid_identity: no copies identidades de sesión ni eludas esa protección.

Flags

Flag	Valor	Qué hace
--repo <selector>	selector de repositorio	filtra los workspaces por proyecto. Acepta id:<id>, path:<ruta> o name:<nombre>; sin prefijo, coincide por id, ruta o nombre de visualización exactos. Sin la flag, enumera todos
--limit <n>	entero positivo	recorta la cantidad devuelta. Predeterminado: 200. 0, negativo o no entero se rechaza
--json	—	devuelve el sobre JSON en vez del texto
--help	—	ayuda del comando
--pairing-code, --environment	valor	flags globales de la CLI (emparejamiento y selección de entorno), aceptadas en cualquier comando

Flags globales de la CLI: --help, --json, --pairing-code, --environment.

Qué devuelve

La respuesta es la lista de workspaces visibles del usuario, opcionalmente filtrada por --repo, recortada en --limit elementos. Junto con ella vienen:

• totalCount — cuántos workspaces coincidieron, antes del recorte de --limit;
• truncated — true cuando ocurrió el recorte.

Es decir: --limit 5 con truncated: true y totalCount: 12 significa “mostré 5 de 12”. El recuento nunca miente por culpa del recorte.

Cada registro de workspace trae identidad, ruta, nombre de visualización, vínculo de parentesco con otros workspaces (parentWorktreeId / childWorktreeIds), issue vinculada y comentario — los mismos campos que usa la barra lateral.

Salida en texto

Sin --json, el comando imprime un bloque por workspace: identidad, branch y ruta en la primera línea, y los campos de parentesco, issue y comentario en las líneas siguientes. Una lista vacía imprime No worktrees found. (el texto heredado conserva la palabra worktree, aunque los registros sean workspaces).

Cuando ocurre el recorte de --limit, la salida termina con truncated: showing <mostrados> de <total>.

La estructura de abajo muestra la forma del texto, con los valores sustituidos por marcadores:

<workspace-id>  <branch>  <ruta>
displayName: <nombre de visualización>
parentWorktreeId: <id del padre | null>
childWorktreeIds: <ids separados por coma | []>
linkedIssue: <número | null>
comment: <comentario>

Los campos de parentesco vacíos aparecen como null y [], nunca omitidos — eso es lo que permite distinguir “sin padre” de “campo ausente”.

Salida en JSON

El sobre es el mismo de toda la CLI: identificación de la llamada, ok, el result con worktrees/totalCount/truncated, y el _meta del runtime. El hints solo existe en el JSON — en el texto, este comando no imprime los próximos pasos.

Ejemplo de salida con --json. Se sustituyeron IDs y rutas; se omitieron otros campos del workspace y del sobre:

{
  "ok": true,
  "result": {
    "worktrees": [{ "id": "<workspace-desechable>", "displayName": "master", "path": "<carpeta-desechable>" }],
    "totalCount": 1,
    "truncated": false
  }
}

La respuesta también contiene _meta.runtimeId y hints.

El hints de este comando sugiere:

elyra canvas list --workspace <selector> --json
elyra terminal list --workspace <selector> --json

Errores observables

Situación	Código	Qué muestra la CLI
--limit no es un entero positivo	invalid_argument	Invalid positive integer for --limit (valor no numérico: Invalid numeric value for --limit)
--repo no coincide con ningún repositorio registrado	repo_not_found	el código, más el próximo paso elyra repo list --json
--repo coincide con más de un repositorio	selector_ambiguous	el código, con la orientación de usar un selector con prefijo (id:)
App cerrada	runtime_unavailable	Could not read Elyra runtime metadata at <perfil>/elyra-runtime.json. Start the Elyra app first. (ruta abreviada aquí)
Shell externo sin identidad de la sesión de la app	agent_operation_denied	Refused: this session’s identity could not be confirmed by Elyra.; ejecuta en la terminal o conversación que recibió la sesión

Los errores pueden traer nextSteps en el sobre JSON.

Comandos relacionados

elyra workspace show --workspace <selector> --json
elyra workspace current --json
elyra worktree list --json
elyra repo list --json

Comando	Para qué sirve
elyra workspace show --workspace <selector> --json	un workspace, por id:/name:/path:/active/current/focused
elyra workspace current --json	el workspace de la carpeta actual
elyra worktree list --json	nombre heredado, solo lectura, mismos registros
elyra repo list --json	repositorios registrados (lo que --repo puede coincidir)

worktree list es el nombre heredado de workspace list: mismo handler, mismos registros. Los selectores branch: e issue: ya no los acepta workspace show, y --worktree sigue aceptándose como alias de compatibilidad de --workspace.

Límites

• --limit recorta lo que se muestra; no hay flag de desplazamiento (--offset) en este comando.