fastapi-cloud-ci-setup - Man Page
fastapi cloud ci setup – Configures a GitHub Actions workflow for deploying the app on push to the specified branch.
Synopsis
fastapi cloud ci setup [Options] [PATH]
Options
- --app-id TEXT
ID of the app to set up CI for (defaults to the app linked to the directory).
- --branch, -b TEXT
Branch that triggers deploys (defaults to the repo’s default branch).
- --secrets-only, -s
Provisions token and sets secrets, skips writing the workflow file.
- --dry-run, -d
Prints steps that would be taken without actually performing them.
- --file, -f TEXT
Custom workflow filename (written to .github/workflows/)
- --help, -h
Show a help message and exit.
Arguments
- PATH
Path to the directory with your app’s pyproject.toml (defaults to current directory).
Examples
# Provisions token, sets secrets, and writes workflow file for the ‘main’ # branch fastapi cloud ci setup
# Same as above but for the ‘develop’ branch fastapi cloud ci setup --branch develop
# Only provisions token and sets secrets, does not write workflow file fastapi cloud ci setup --secrets-only
# Prints the steps that would be taken without performing them fastapi cloud ci setup --dry-run
# Writes workflow to .github/workflows/ci.yml fastapi cloud ci setup --file ci.yml
Notes
This is equivalent to fastapi-cloud-setup-ci(1).
See Also
Referenced By
fastapi-cloud-ci(1), fastapi-cloud-ci-print-workflow(1), fastapi-cloud-setup-ci(1).
July 2026