FASTAPI-CLOUD-CI-SETUP(1)

πŸ“¦ version 0.24.0, in fedora 44

πŸ’– fastapi-cloud-ci-setup β€” the girlies' guide to auto-deploy πŸ’–

okay so bestie, this is a User Commands page for fastapi-cloud-ci-setup πŸ’… and it is literally the moment your app learns to deploy itself. We're talking GitHub Actions workflow setup that fires off a deploy every time you push to the branch you picked. no cap. πŸ”₯


✨ NAME ✨

fastapi cloud ci setup β€” configures a GitHub Actions workflow for deploying the app on push to the specified branch πŸ¦‹

like… it writes the little robot that ships your code for you. obsessed.


🌸 SYNOPSIS 🌸

fastapi cloud ci setup [OPTIONS] [PATH]

πŸŽ€ OPTIONS πŸŽ€

  • --app-id TEXT β€” the ID of the app you're setting up CI for. if you don't pass one, it defaults to the app that's linked to the directory you're in 🫢
  • --branch, -b TEXT β€” the branch that triggers deploys. leave it out and it defaults to the repo's default branch ✨
  • --secrets-only, -s β€” provisions the token and sets the secrets, but skips writing the workflow file. secrets yes, workflow file no πŸ’…
  • --dry-run, -d β€” prints the steps that would be taken without actually performing them πŸ‘€ perfect for the "wait what is this about to do to me" girlies
  • --file, -f TEXT β€” custom workflow filename, and it gets written to .github/workflows/ πŸ“
  • --help, -h β€” shows a help message and exits πŸŽ€

🧚 ARGUMENTS 🧚

  • PATH β€” path to the directory with your app's pyproject.toml. defaults to the 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

the --file ci.yml one? chef's kiss. it goes straight into .github/workflows/ci.yml 😌


πŸ’œ NOTES πŸ’œ

This is equivalent to fastapi-cloud-setup-ci(1) β€” same energy, different entrance πŸ¦‹


πŸ‘‘ SEE ALSO πŸ‘‘


bestie if you're ever unsure, run it with --dry-run (-d) first. it prints the steps that would be taken without performing them, so you get the whole vibe check before anything actually happens πŸ™ˆ

mwah πŸ’‹ that's the whole page. go set up your CI and let the robots do the boring part.

July 2026 β€” FASTAPI-CLOUD-CI-SETUP(1) β€” that's the version and the date, periodt πŸ’…βœ¨

πŸ“¦ where this page comes from