Skip to content

Start a project

A project is the unit of work in Subaya: it holds your design, requirements, simulations, and (optionally) a connected Git repo. Projects live inside a workspace, which lives inside your organization. See Core concepts for how these fit together.

Every project is typed — either an FPGA project or an embedded project — because the toolchains and phases differ:

Terminal window
suya project create \
--name "Blinky" \
--workspace <workspace-id> \
--type embedded
Flag Meaning
--name Human-readable project name (required)
--workspace Workspace id the project belongs to (required)
--type fpga or embedded (required)
--slug URL-safe slug (defaults to a slug derived from the name)
--device A device id from the catalog to target (optional)

Find your workspace id in the console, or list projects you already have:

Terminal window
suya project list --workspace <workspace-id>

When you work inside a project directory, Subaya keeps a small .subaya/config.toml that records the project id. Most commands then default --project from it, so you can drop the flag:

Terminal window
suya project show # shows the project from .subaya/config.toml
suya project phase # get or set the current phase

If you know the chip or board you’re targeting, attach it from the curated catalog:

Terminal window
suya device search --type embedded
suya device show <device-id>
suya device set <device-id>