Documentation
Integrate BlueForge with your stack
Use the whole forge-* platform, or only the parts you need: the catalog registry, the asset pipeline and the public packages work from any CI — GitHub Actions included — with your own identity provider for your users.
What you can integrate
- Deploys. The
forgeCLI builds and deploys an app described by ablueforge.config.json, and reports its status. - Product identity and copy. Two YAML sidecars in your repo —
blueforge.product.ymlandblueforge.features.yml— describe the product the catalog shows. - The registry and catalog.
POST /api/deploymentsrecords what is live;GET /api/productsreturns the merged catalog as JSON, optionally for one tenant. - Brand imagery. Logos, social cards, covers and screenshots, uploaded by sha256 so a deploy only sends what changed.
- Packages.
@blueforge-studio/*packages from the packr registry: the sidecar schemas, the marketing kit and provider-neutral service adapters.
Three paths
The full platform
Your code on forge-git, deploys by forge-control, identity by forge-auth, packages from packr. A successful deploy registers itself and uploads your declared imagery — nothing to wire by hand.
QuickstartAPI + packages from your own CI
Keep GitHub and your own CI. Validate your sidecars with the schemas package, then register each deploy with POST /api/deployments using an org API key from forge-auth.
API referenceA promotion site
Your own catalog site on BlueForge, filled from what your deploys register — per-tenant catalog, showcase and promotions, scoped by your forge-auth organization.
Promotion siteGuides
- QuickstartYour first deploy with the forge CLI: log in, create an org, init, deploy.
- Sidecarsblueforge.product.yml and blueforge.features.yml — the two files that describe your product.
- API referenceRegister deployments, read the catalog, search, feeds — with auth, status codes and curl.
- Asset syncHow logos, social cards, covers and screenshots reach the catalog, and the approval gate.
- PackagesThe @blueforge-studio/* packages integrators use, and how to install them from packr.