콘텐츠로 이동

CLI 레퍼런스

suya 명령어 체계의 전체 색인입니다. 아래 각 그룹은 산문 설명, 예제, 플래그 세부 정보를 담은 /cli/* 하위의 자체 페이지로 연결됩니다.

모든 명령어는 다음을 허용합니다.

Flag 의미
--host API 엔드포인트 (기본값 https://subaya-dev.com)
--token 인증 토큰, 가장 높은 우선순위의 자격 증명
--json 기계가 읽을 수 있는 JSON 출력
--pretty 사람이 보기 좋게 포맷된 출력
-q, --quiet 필수가 아닌 출력 억제
-v, --verbose 추가 진단 출력

에이전트와 CI의 인증은 SUBAYA_API_KEY 환경 변수를 사용합니다 — 인증 및 API 키를 참고하시기 바랍니다. .subaya/config.toml의 로컬 프로젝트 구성은 프로젝트 id를 보유하므로, 대부분의 명령어는 거기에서 --project를 기본값으로 사용합니다.

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

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

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

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)

BitCrucible를 통한 하드웨어 검증. 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]

검색 및 지식 탐색. 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

계획 산출물. 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)

아키텍처 및 임베디드 핀 플래닝. 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

요구사항. CLI: req를 참고하시기 바랍니다.

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

코드 및 설계 리뷰. CLI: review를 참고하시기 바랍니다.

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

mmdc를 통해 SVG/PNG로 렌더링되는 Mermaid 다이어그램. CLI: diagram를 참고하시기 바랍니다.

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

디바이스 카탈로그. CLI: device를 참고하시기 바랍니다.

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

세션 파드에 연결하고 해제합니다. CLI: session를 참고하시기 바랍니다.

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

최상위 유지 관리 명령어. 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