FASTAPI-CLOUD-SETUP-CI(1)

📦
version 0.24.0 · 2 versions
, in fedora 44

✨ FASTAPI-CLOUD-SETUP-CI ✨

okay bestie, listen. this is the fastapi cloud setup-ci manual page, and it's genuinely one of the cutest little commands in the whole fastapi cloud family. what does it do? it configures a GitHub Actions workflow for deploying your app on push to the branch you pick. that's it. that's the whole vibe. automatic deploys, no cap. 💅

🌸 SYNOPSIS 🌸

fastapi cloud setup-ci [OPTIONS] [PATH]

yes queen, that's the whole shape of it. options, then optionally a path. slay.

💖 OPTIONS 💖

  • --app-id TEXT — the ID of the app you wanna set up CI for. if you don't pass it, it defaults to the app linked to the directory. iykyk 🫶
  • --branch, -b TEXT — the branch that triggers deploys. don't specify it? it just uses the repo's default branch. iconic default behaviour fr fr.
  • --secrets-only, -s — this one provisions the token and sets the secrets, but skips writing the workflow file entirely. so you get the secret sauce without the yaml. obsessed. 🎀
  • --dry-run, -d — prints out the steps that would be taken, without actually performing them. it's giving window shopping. literally no changes happen. 👑
  • --file, -f TEXT — custom workflow filename. this gets written to .github/workflows/. so you get to name your own yaml baby. 🦋
  • --help, -h — shows a help message and exits. classic. we love a helpful king. ⭐

🧚 ARGUMENTS 🧚

  • PATH — path to the directory that has your app's pyproject.toml. if you don't give one, it defaults to the current directory. so you can just vibe where you already are. 💜

🌈 EXAMPLES 🌈

# Provisions token, sets secrets, and writes workflow file for the 'main'
# branch
fastapi cloud setup-ci
# Same as above but for the 'develop' branch
fastapi cloud setup-ci --branch develop
# Only provisions token and sets secrets, does not write workflow file
fastapi cloud setup-ci --secrets-only
# Prints the steps that would be taken without performing them
fastapi cloud setup-ci --dry-run
# Writes workflow to .github/workflows/ci.yml
fastapi cloud setup-ci --file ci.yml

look at those. every single one of them ate. 🔥

💀 NOTES 💀

this is equivalent to fastapi-cloud-ci-setup(1). same energy, different name. not me telling you they're the same thing... 🙈

👑 SEE ALSO 👑

the whole friend group, assembled:

and then, standing alone with main character energy:

okay that's the whole page bestie, hope your deploys are forever green ✅ and your workflows never flake. this was FASTAPI-CLOUD-SETUP-CI(1) from User Commands, dated August 2026. go set up that CI. it's giving automation. it's giving slay. periodt. 💖✨🎀

📦 where this page comes from