Skip to content
FastAPI Cloud Logo FastAPI Cloud Docs

Link Command

The fastapi cloud link command links a local directory to an existing FastAPI Cloud app.

This is useful when you want to connect your local project to an app that was already created, without triggering a new deployment.

Usage

Section titled “Usage”
Terminal window
fastapi cloud link

The command is interactive and will guide you through selecting a team and app.

What This Command Does

Section titled “What This Command Does”

When you run fastapi cloud link, the CLI will:

  • Verify you are logged in
  • Check that the current directory is not already linked to an app
  • Prompt you to select a team
  • Prompt you to select an app from that team
  • Create a .fastapicloud configuration directory linking your project to the selected app
Section titled “Related Commands”
  • fastapi deploy - Deploy your app (also creates a link on first deploy)
  • fastapi cloud unlink - Remove the local .fastapicloud configuration
  • fastapi cloud login - Authenticate with FastAPI Cloud