Skip to content
Subaya

Quickstart

From zero to a passing simulation in three steps. The suya CLI drives everything — for humans, AI agents, and CI alike.

1. Install the CLI

Section titled “1. Install the CLI”
Terminal window
# macOS / Linux
curl -fsSL https://subaya-dev.com/cli/install.sh | sh
Terminal window
# Windows
irm https://subaya-dev.com/cli/install.ps1 | iex

See the Download page for all platforms and checksums. Verify with:

Terminal window
suya version

2. Sign in

Section titled “2. Sign in”
Terminal window
suya auth login

This opens a browser to authorize the CLI, then stores a token locally. For agents and CI, set the SUBAYA_API_KEY environment variable instead — no browser needed:

Terminal window
export SUBAYA_API_KEY="sk_..."
suya auth whoami

See Authentication & API keys for the full story.

3. Run your first simulation

Section titled “3. Run your first simulation”
Terminal window
suya project create --name adder --workspace <workspace-id> --type fpga


suya sim run \
  --tool ryusim \
  --tb tb/adder_tb.py \
  --top adder \
  --source ./rtl \
  --wait

--source packs your RTL tree and ships it to a cloud RyuSim run; --wait polls until the run reaches a terminal state and prints a pass/fail summary. Then:

  • suya sim report <run-id> — results summary
  • suya sim logs <run-id> --follow — stream the run log
  • suya sim wave <run-id> — locate the waveform artifact (analyze with wf)
  • suya sim list — recent runs

Where to next

Section titled “Where to next”