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.
Indicateurs globaux
Section intitulée « Indicateurs globaux »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.
suya auth login [--no-browser] # OAuth (loopback + manual-code fallback)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 identityVoir 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 projectVoir 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 stateVoir CLI : sim.
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 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)Validation matérielle via BitCrucible. Voir 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]Récupération et recherche de connaissances. Voir 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 timestampArtefacts de planification. Voir 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)Architecture et planification de brochage embarqué. Voir 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 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 intentsuya arch validate --plan <pid> # structural validate (headless CubeMX authoritative)suya arch generate --plan <pid> # generate .ioc from pin-plansuya arch ioc commit # generate the plan's .ioc and commit to connected repoExigences. Voir CLI : req.
suya req add # add a requirement to the projectsuya req list # list the project's requirementsRevues de code et de conception. Voir CLI : review.
suya review create|show|list|comment|comments|reply|resolve|approve|request|reopen|close|rounds|diffDiagrammes Mermaid, rendus via mmdc en SVG/PNG. Voir CLI : diagram.
suya diagram create|update|show|list|export|render|deleteCatalogue d’appareils. Voir CLI : device.
suya device search [--type fpga|embedded]suya device show <id>suya device set <id> # assign a device to a projectSe rattacher à votre pod de session et le libérer. Voir CLI : session.
suya attach [--console|--no-console] # attach to your session pod (reconnects)suya detach # release the session pod for reapingmaintenance
Section intitulée « maintenance »Commandes d’entretien de premier niveau. Voir 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