CLI Reference

The foundry CLI scaffolds a platform, reconciles it with the filesystem, runs it locally, generates its CI/CD, and performs database operations. Each command is documented in detail on its own page.

Commands

CommandWhat it doesWrites
foundry initCreate or refresh a platformfoundry.json, .foundry/
foundry generateGenerate pipeline, scripts, tfvars, and multi-repo thin callers.github/workflows/deploy.yml, ci/scripts/, ci/iac/{env}/
foundry syncReconcile manifest ↔ filesystem.foundry/workspace.yml
foundry runRun services locally (Services UI)
foundry dbLiquibase ops with auto SSH tunnels
foundry githubGitHub token + cross-repo discovery.foundry/config.yml (with --save)
foundry configShow toolchain + project status
foundry aliasManage command aliasesshim binaries

The shape of a Foundry project

Most commands operate on the current directory and expect a foundry.json at the root. init creates it; sync keeps the workspace map current; run reads the workspace to launch services; generate emits the in-repo CI/CD for a monorepo. db, github, config, and alias are utilities around that core.