Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Command Reference

Global flags

FlagEnvDescription
--jsonJSON output instead of tables
--api-url <URL>SSYNTH_API_URLOverride API endpoint

ssynth login

ssynth login [--api-key <KEY>] [--dev] [--username <NAME>]
FlagDescription
--api-keyAPI key (sk_live_...). Prompts if omitted.
--devUse dev-login (local development only)
--usernameUsername for dev-login (default: dev)

ssynth job submit

ssynth job submit <PATH> [OPTIONS]
OptionEnvDescription
<PATH>Directory or .tar.gz/.zip archive
--project <ID>SSYNTH_PROJECTProject ID
--target <ID>Target (e.g., ice40:hx8k:ct256)
--top <MODULE>Top-level module name
--constraints <FILES...>Constraint files
--seeds <N>Seed count (1-32)
--pick <STRATEGY>best_timing or best_area
--priority <LEVEL>interactive, standard, batch
--parallelism <N>Concurrent seeds (1-16)
--steps <STEPS>Comma-separated: synth,pnr,bitstream
--max-runtime <DUR>e.g., 2h, 30m, 1h30m
--max-memory <SIZE>e.g., 8GB, 4096MB
--profile <ID>Build profile ID
--archive-format <FMT>tar_gz or zip
--waitStream logs until completion
--idempotency-key <KEY>Deduplication key

ssynth job status

ssynth job status <JOB_ID> [--watch]

ssynth job list

ssynth job list [--status <STATUS>] [--project <ID>] [--limit <N>]

ssynth job logs

ssynth job logs <JOB_ID> [--follow] [--offset <N>] [--limit <N>]

ssynth job cancel

ssynth job cancel <JOB_ID>

ssynth job retry

ssynth job retry <JOB_ID> [--scope failed|all]

ssynth job clone

ssynth job clone <JOB_ID> [--seeds <N>] [--parallelism <N>] [--priority <LEVEL>] [--pick <STRATEGY>] [--target <ID>]

ssynth artifact list

ssynth artifact list <JOB_ID>

ssynth artifact download

ssynth artifact download <JOB_ID> [--output-dir <DIR>]

ssynth project list / create / get / update / delete

ssynth project list
ssynth project create --slug <SLUG> --name <NAME> [--target <ID>]
ssynth project get <ID>
ssynth project update <ID> [--name <NAME>] [--retention-days <N>]
ssynth project delete <ID>

ssynth api-key create / list / revoke

ssynth api-key create --name <NAME> [--expires-at <ISO-DATE>]
ssynth api-key list
ssynth api-key revoke <ID>

ssynth profile list / create / get / update / delete

ssynth profile list --project <ID>
ssynth profile create --project <ID> --name <NAME> --target <TARGET> [--description <TEXT>] [--yosys-passes <CSV>] [--nextpnr-flags <CSV>] [--bitstream-flags <CSV>]
ssynth profile get <ID>
ssynth profile update <ID> [--name <NAME>] [--description <TEXT>] [--target <TARGET>] [--yosys-passes <CSV>] [--nextpnr-flags <CSV>] [--bitstream-flags <CSV>]
ssynth profile delete <ID>

ssynth targets

ssynth targets

ssynth usage

ssynth usage

ssynth config show

ssynth config show