Skip to content
Subaya

Connect a GitHub repo

Subaya projects are Git-backed. Your design source, testbenches, and generated artifacts live in a GitHub repository that Subaya reads and writes through a GitHub App installation. You can either create a fresh repo with a starter scaffold, or connect a repo you already have.

Install the GitHub App

Section titled “Install the GitHub App”

Connecting a repo requires the Subaya GitHub App to be installed on the owning account or organization. Install it from the console, then note the installation id — every repo command needs it.

Option A — create a new repo with a scaffold

Section titled “Option A — create a new repo with a scaffold”

This creates a new GitHub repo and pushes a type-specific starter scaffold (directory layout, a sample testbench, and a .subaya/config.toml):

Terminal window
suya repo create \
  --installation <installation-id> \
  --name blinky          # defaults to the project slug

--project defaults to the project recorded in .subaya/config.toml; pass it explicitly if you’re outside the project directory.

Option B — connect an existing repo

Section titled “Option B — connect an existing repo”

Already have a repo? Connect it instead:

Terminal window
suya repo connect \
  --installation <installation-id> \
  --owner my-org \
  --repo my-existing-repo

Check the connection

Section titled “Check the connection”
Terminal window
suya repo status

This shows the connected repo and the project’s config state. Once connected, generated artifacts — for example an STM32 .ioc from suya arch ioc commit — are committed straight back to the repo.

Next steps

Section titled “Next steps”