OrkStageOrkStage

Repository map

The focused repositories that make up OrkStage, what each one publishes, how they depend on each other, and the workspace that brings them together.

The repositories

OrkStage is split into focused repositories in the orkstage organization. The split kept the git history of every part. Shared code is published as versioned packages, and git submodules appear only in the orkstage-dev workspace.

RepositoryContentsPublishesLicense
orkstageControl API, worker, shared packages, platform image, docs@orkstage/contracts, /authorization, /templates and /domain; ghcr.io/orkstage/platformAGPL-3.0
orkstage-ee (private)Enterprise source, a git submodule of orkstage at apps/api/src/ee that clones skipBuilt into the official platform imageOrkStage Enterprise License
orkstage-consoleThe web consoleghcr.io/orkstage/consoleAGPL-3.0
orkstage-cliork and the scan engineSigned ork binaries, @orkstage/scan (WASM), manifests for Homebrew, Scoop and wingetAGPL-3.0
orkstage-modulesOpenTofu modules and the runner imageGit tags vX.Y.Z, ghcr.io/orkstage/tofu-runner:<tag>Apache-2.0
orkstage-siteThis siteStatic site on S3 and CloudFront (orkstage.io)MIT for code, CC BY 4.0 for content
orkstage-devWorkspace: submodules, Compose stack, scriptsNothingMIT
.githubOrganization profile and default community filesNothing
orkstage-licensingLicense signing service (private)Nothing publicProprietary

The packages and images are not published yet. Until they are, the orkstage-dev workspace builds everything from the submodules.

How the repositories depend on each other:

orkstage-console ──npm──▶ @orkstage/contracts, /authorization, /templates, /domain
orkstage (api)   ──npm──▶ @orkstage/scan (from orkstage-cli)
orkstage (worker)──image─▶ ghcr.io/orkstage/tofu-runner:<modules tag>
orkstage-cli     ──HTTP──▶ OrkStage API (integration contract, OpenAPI)
orkstage-site    ──file──▶ OpenAPI JSON published by orkstage CI
orkstage-dev     ──git submodules──▶ every repository (pinned commits)

The workspace

infra/ (supporting services for local runs, platform image, CloudFormation for the customer deployment role)
docs/ (architecture, API map, ADRs, specs)
orkstage-console/ (Next.js console)
orkstage-cli/ (the ork binary, the scan engine and its WebAssembly package)
orkstage-modules/ (OpenTofu modules, one per resource type, and the runner image)
orkstage-site/ (this website and the docs)
docker-compose.yml (the full stack, built from the submodules)
scripts/ (git hooks, branch protection for every repository)

Start with the development setup:

git clone --recurse-submodules git@github.com:orkstage/orkstage-dev.git
cd orkstage-dev
pnpm bootstrap

On this page