Aller au contenu

Référence de la CLI

L’index exhaustif de la surface des commandes suya. Chaque groupe ci-dessous renvoie vers sa propre page sous /cli/* pour la prose, les exemples et le détail des options.

Chaque commande accepte :

Indicateur Signification
--host Point d’accès de l’API (par défaut https://subaya-dev.com)
--token Jeton d’authentification, identifiant de plus haute précédence
--json Sortie JSON exploitable par une machine
--pretty Sortie mise en forme pour l’humain
-q, --quiet Supprimer la sortie non essentielle
-v, --verbose Sortie de diagnostic supplémentaire

L’authentification pour les agents et la CI utilise la variable d’environnement SUBAYA_API_KEY — voir Authentification et clés d’API. Une configuration de projet locale à .subaya/config.toml contient l’id du projet, de sorte que la plupart des commandes déduisent --project à partir d’elle.

Voir CLI : auth.

Terminal window
suya auth login [--no-browser] # OAuth (loopback + manual-code fallback)
suya auth logout # log out and revoke the local token
suya auth status # local auth status, no server call
suya auth whoami # call the API and print the resolved identity

Voir CLI : project.

Terminal window
suya project create --name <n> --workspace <id> --type <fpga|embedded> [--slug <s>] [--device <id>]
suya project init # alias of create
suya project list --workspace <id>
suya project phase # get or set the current project phase
suya project show # defaults to the .subaya/config.toml project

Voir CLI : repo.

Terminal window
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 state

Voir CLI : sim.

Terminal window
suya sim run --tb <path> --top <module> [--project <id>] [--source <dir>] \
[--tool ryusim|verilator|icarus|questa|xsim|renode] [--tier S] \
[--wait] [--no-cache] [--arg <a>]...
suya sim list # recent runs
suya sim report <run-id> # status + results summary
suya sim logs <run-id> [--follow]
suya sim rerun <run-id> [--wait]
suya sim wave <run-id> # locate the waveform artifact (hand off to wf)

Validation matérielle via BitCrucible. Voir CLI : hw.

Terminal window
suya hw agent register --name <n>
suya hw agent list
suya hw agent revoke <id>
suya hw agent run
suya hw run --target <t> [--test-plan <file>]
suya hw history [--project <id>] [--limit N]

Récupération et recherche de connaissances. Voir CLI : rag.

Terminal window
suya rag search <query> [--scope curated|project:42]... [--top-k N] [--semantic-only]
suya rag read <chunk-id> # full body of a curated chunk
suya rag status # per-scope chunk counts + last ingest timestamp

Artefacts de planification. Voir CLI : plan.

Terminal window
suya plan docs list
suya plan docs show <id>
suya plan docs approve <id> [--section <s>]
suya plan items list
suya plan items show <id> # work-item tree
suya plan diagrams ...
suya plan session # prints how to open a planner session (suya attach)

Architecture et planification de brochage embarqué. Voir CLI : arch.

Terminal window
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 set --plan <pid> --pin <PA5> --signal <USART2_TX> [--af --mode --label]
suya arch peripheral configure --plan <pid> --peripheral <USART2> [--mode --params <json>]
suya arch clock set --plan <pid> ... # clock-tree node intent
suya arch validate --plan <pid> # structural validate (headless CubeMX authoritative)
suya arch generate --plan <pid> # generate .ioc from pin-plan
suya arch ioc commit # generate the plan's .ioc and commit to connected repo

Exigences. Voir CLI : req.

Terminal window
suya req add # add a requirement to the project
suya req list # list the project's requirements

Revues de code et de conception. Voir CLI : review.

Terminal window
suya review create|show|list|comment|comments|reply|resolve|approve|request|reopen|close|rounds|diff

Diagrammes Mermaid, rendus via mmdc en SVG/PNG. Voir CLI : diagram.

Terminal window
suya diagram create|update|show|list|export|render|delete

Catalogue d’appareils. Voir CLI : device.

Terminal window
suya device search [--type fpga|embedded]
suya device show <id>
suya device set <id> # assign a device to a project

Se rattacher à votre pod de session et le libérer. Voir CLI : session.

Terminal window
suya attach [--console|--no-console] # attach to your session pod (reconnects)
suya detach # release the session pod for reaping

Commandes d’entretien de premier niveau. Voir CLI : maintenance.

Terminal window
suya version # version metadata
suya update [--check] # upgrade to the latest release
suya install [--skills] [--path <p>] [--force] # install Subaya integrations
suya completion <shell> # shell autocompletion