Listar todos los comandos

Muestra todos los comandos del CLI con sus argumentos y su descripción. Con --json devuelve el árbol completo, con cada opción, para que un script o un agente de IA descubra qué puede hacer sin leer la documentación. Es el equivalente a stripe --map json. También funciona como plazbot map.

bash

01plazbot commands [--json]

Parámetros

Parámetro	Flag	Requerido	Descripción
JSON	`--json`	No	Imprime el árbol de comandos en JSON

Los comandos y opciones internos (ocultos en --help) no aparecen.

Ejemplos

bash

01# Ver el árbol de comandos
02plazbot commands
03 
04# Todos los comandos, argumentos y opciones en JSON
05plazbot commands --json
06 
07# Solo las rutas de los comandos
08plazbot commands --json | jq -r '.commands[].command'

Resultado

text

01  plazbot contacts  Read and update contacts (CRM)
02    plazbot contacts list  List contacts (the inbox order: newest activity first)
03    plazbot contacts get <contactId>  Get a contact with all its fields
04    plazbot contacts search  Find contacts by phone number or email
05    ...
06  plazbot api <method> <path>  Send an authenticated request to any Plazbot API endpoint
07 
08  Run 'plazbot <command> --help' for options and examples.

Salida JSON

json

01{
02  "version": "0.6.0",
03  "commands": [
04    {
05      "command": "plazbot contacts get",
06      "description": "Get a contact with all its fields",
07      "aliases": [],
08      "arguments": [
09        { "name": "contactId", "required": true, "variadic": false, "description": "Contact ID" }
10      ],
11      "options": [
12        { "flags": "--json", "description": "Output machine-readable JSON" },
13        { "flags": "-w, --workspace <id>", "description": "Workspace ID (default: the active workspace)" },
14        { "flags": "-z, --zone <zone>", "description": "Zone LA or EU (default: the active zone)" }
15      ],
16      "subcommands": []
17    }
18  ]
19}

Campo	Descripción
`command`	Comando completo, ej. `plazbot contacts get`
`aliases`	Nombres alternativos (`contact`, `map`...)
`arguments`	Argumentos posicionales y si son obligatorios
`options`	Flags visibles, con `default` y `choices` cuando los tienen
`subcommands`	Nombres de los subcomandos (vacío en los comandos finales)

Ver también: Usar el CLI con IA y scripts y plazbot skill.