Referencia de la CLI
El índice exhaustivo de la superficie de comandos de suya. Cada grupo de abajo enlaza a su
propia página bajo /cli/* para prosa, ejemplos y detalle de indicadores.
Indicadores globales
Sección titulada «Indicadores globales»Todos los comandos aceptan:
| Indicador | Significado |
|---|---|
--host |
Endpoint de la API (predeterminado https://subaya-dev.com) |
--token |
Token de autenticación, credencial de mayor precedencia |
--json |
Salida JSON legible por máquina |
--pretty |
Salida con formato para personas |
-q, --quiet |
Suprime la salida no esencial |
-v, --verbose |
Salida de diagnóstico adicional |
La autenticación para agentes y CI usa la variable de entorno SUBAYA_API_KEY:
consulta Autenticación y claves de API. Una configuración local de proyecto en
.subaya/config.toml contiene el id del proyecto, de modo que la mayoría de los comandos toman --project
de ella por defecto.
Consulta CLI: auth.
suya auth login [--no-browser] # OAuth (loopback, falling back to the device flow)suya auth logout # log out and revoke the local tokensuya auth status # local auth status, no server callsuya auth whoami # call the API and print the resolved identityproject
Sección titulada «project»Consulta CLI: project.
suya project create --name <n> --workspace <id> --type <fpga|embedded> [--slug <s>] [--device <id>]suya project init # alias of createsuya project list --workspace <id>suya project phase # get or set the current project phasesuya project show # defaults to the .subaya/config.toml projectConsulta CLI: repo.
suya repo create --installation <id> [--name <n>] [--project <id>]suya repo connect --installation <id> --owner <o> --repo <r> [--project <id>]suya repo status # connected repo + config stateConsulta CLI: sim.
suya sim run --tb <path> --top <module> [--project <id>] [--source <dir>] \ [--tool ryusim|verilator|icarus|questa|renode] [--tier S] \ [--wait] [--no-cache] [--arg <a>]...suya sim list # recent runssuya sim report <run-id> # status + results summarysuya sim logs <run-id> [--follow]suya sim rerun <run-id> [--wait]suya sim wave <run-id> # locate the waveform artifact (hand off to wf)Validación de hardware vía BitCrucible. Consulta CLI: hw.
suya hw agent register --name <n>suya hw agent listsuya hw agent revoke <id>suya hw agent runsuya hw run --target <t> [--test-plan <file>]suya hw history [--project <id>] [--limit N]Recuperación y búsqueda de conocimiento. Consulta CLI: rag.
suya rag search <query> [--scope curated|project:42]... [--top-k N] [--semantic-only]suya rag read <chunk-id> # full body of a curated chunksuya rag status # per-scope chunk counts + last ingest timestampArtefactos de planificación. Consulta CLI: plan.
suya plan docs listsuya plan docs show <id>suya plan docs approve <id> [--section <s>]suya plan items listsuya plan items show <id> # work-item treesuya plan diagrams ...suya plan session # prints how to open a planner session (suya attach)Arquitectura y planificación de pines embebidos. Consulta CLI: arch.
suya arch module add --name <n> [--project <id>] [--kind <k>] [--description <d>] [--parent <pid>]suya arch module list --project <id>suya arch pin-plan create (--mcu <part> | --board <name>) [--project <id>] [--name <n>]suya arch pin-plan list --project <id>suya arch pin-plan show --plan <pid>suya arch pin-plan review-doc --plan <pid>suya arch pin-plan rm --plan <pid> # delete the plan + its pins/peripherals/clockssuya arch pin set --plan <pid> --pin <PA5> --signal <USART2_TX> [--af --mode --label]suya arch pin rm --plan <pid> --pin <PA5> # free a pinsuya arch peripheral configure --plan <pid> --peripheral <USART2> [--mode --params <json>]suya arch peripheral rm --plan <pid> --peripheral <USART2>suya arch clock set --plan <pid> ... # clock-tree node intentsuya arch clock rm --plan <pid> --node <SYSCLK>suya arch validate --plan <pid> # structural validate (headless CubeMX authoritative)suya arch generate --plan <pid> [--wait] # enqueue a headless CubeMX run; --wait polls + prints the resolved .iocsuya arch generate-status --run <id> # poll a generate run and print its resolved .iocsuya arch ioc commit # generate the plan's .ioc and commit to connected repoRequisitos. Consulta CLI: req.
suya req add --title <t> [--parent REQ-N] # add a requirementsuya req list [filters] [--pretty|--tree] # list (see filters below)suya req show REQ-N # show one requirementsuya req update REQ-N --status deferred # edit fields (>=1 required)suya req rm REQ-N [--yes] # hard delete (confirm + reference warning)suya req tag REQ-N --add console --rm old # cross-cutting tagssuya req link REQ-N --to work_item:42 --to test:tests/boot.rs::cold_bootsuya req coverage [--untested] # leaf reqs with no linked test (CI gate)suya req import --file specs.yaml # bulk upsert on keysuya req export --format yaml|csv|md # round-trip for review-by-diffsuya req baseline list | diff [<id>|latest] # snapshot at approval vs driftRevisiones de código y de diseño. Consulta CLI: review.
suya review create|show|list|comment|comments|reply|resolve|approve|request|reopen|close|rounds|diffdiagram
Sección titulada «diagram»Diagramas Mermaid, renderizados vía mmdc a SVG/PNG. Consulta CLI: diagram.
suya diagram create|update|show|list|export|render|deleteCatálogo de dispositivos. Consulta CLI: device.
suya device search [--type fpga|embedded]suya device show <id>suya device set <id> # assign a device to a projectsession
Sección titulada «session»Conéctate y libera tu pod de sesión. Consulta CLI: session.
suya attach [--console|--no-console] # attach to your session pod (reconnects)suya detach # release the session pod for reapingmaintenance
Sección titulada «maintenance»Comandos de mantenimiento de nivel superior. Consulta CLI: maintenance.
suya version # version metadatasuya update [--check] # upgrade to the latest releasesuya install [--skills] [--path <p>] [--force] # install Subaya integrationssuya completion <shell> # shell autocompletion