FastAPI Cloud

https://fastapicloud.com/docs/
Admin
FastAPI Cloud is a cloud deployment platform that enables developers to deploy FastAPI applications...
Tokens:35,465
Snippets:440
Trust Score:7.6
Update:1 day ago
Show doc for...
Tokens:
Raw
### Example prompts for ChatGPT or Codex

Source: https://fastapicloud.com/docs/other-resources/coding-agent-plugins/

Use these prompts after installing the FastAPI Cloud plugin to ask the agent to create and deploy an app or show runtime logs.

```text
Create a new FastAPI app and deploy it to FastAPI Cloud.
```

```text
Show me the latest runtime logs for this app.
```

--------------------------------

### Install FastAPI framework skills with Library Skills

Source: https://fastapicloud.com/docs/other-resources/coding-agent-plugins/

Run this command to install FastAPI framework skills via Library Skills. When prompted, choose the directory used by your coding agent (e.g., .claude/skills for Claude Code).

```text
uvx library-skills
```

--------------------------------

### Output when environment variables exist

Source: https://fastapicloud.com/docs/fastapi-cloud-cli/env/

Example output when environment variables exist.

```text
Environment variables:

DATABASE_URL
API_KEY
DEBUG_MODE
```

--------------------------------

### Install FastAPI with pip

Source: https://fastapicloud.com/docs/getting-started/

Install fastapi[standard] using pip. This includes the FastAPI Cloud CLI.

```bash
pip install "fastapi[standard]"
```

--------------------------------

### Run with Defaults: fastapi cloud setup-ci

Source: https://fastapicloud.com/docs/fastapi-cloud-cli/setup-ci/

Runs the setup with default settings, using the `main` branch and default workflow filename.

```bash
fastapi cloud setup-ci
```

--------------------------------

### GitHub Actions workflow for deploying to FastAPI Cloud

Source: https://fastapicloud.com/docs/advanced-features/deploy-tokens/

Example workflow that deploys on push to main or manual dispatch. It checks out the repo, installs uv, and runs fastapi deploy with secrets for token and app ID.

```yaml
name: "Deploy"

on:
  push:
    branches:
      - main
  workflow_dispatch:

jobs:
  deploy:
    name: "Deploy"
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v5
        with:
          fetch-depth: 0

      - name: Install the latest version of uv
        uses: astral-sh/setup-uv@v7

      - name: Deploy to FastAPI Cloud
        run: uv run fastapi deploy
        env:
          FASTAPI_CLOUD_TOKEN: ${{ secrets.FASTAPI_CLOUD_TOKEN }}
          FASTAPI_CLOUD_APP_ID: ${{ secrets.FASTAPI_CLOUD_APP_ID }}
```

--------------------------------

### Install dependencies with pip

Source: https://fastapicloud.com/docs/getting-started/existing-project/

Command to install the project and its dependencies after adding `fastapi[standard]`.

```bash
pip install -e .
```

--------------------------------

### Install FastAPI Cloud skills in Claude Code

Source: https://fastapicloud.com/docs/other-resources/coding-agent-plugins/

Run these commands in Claude Code to add the fastapicloud/skills marketplace and install the FastAPI Cloud skills.

```text
/plugin marketplace add fastapicloud/skills
```

```text
/plugin install fastapicloud@fastapicloud-skills
```

--------------------------------

### Output when no environment variables exist

Source: https://fastapicloud.com/docs/fastapi-cloud-cli/env/

Example output when no environment variables exist.

```text
No environment variables found.
```

--------------------------------

### Build frontend and deploy with npm

Source: https://fastapicloud.com/docs/builds-and-deployments/frontend/

Run the frontend build command before every deployment, then deploy the app. This example uses `npm`; if your frontend uses a different package manager, use its build command instead (e.g., `pnpm build`, `yarn build`, or `bun run build`).

```bash
npm run build
fastapi deploy
```

--------------------------------

### Example log output format

Source: https://fastapicloud.com/docs/fastapi-cloud-cli/logs/

Example output showing the log line format: timestamp (UTC), level (DEBUG, INFO, WARNING, ERROR, CRITICAL), and message.

```bash
┃ 2024-01-15T10:30:45.123Z INFO: Application startup complete.
┃ 2024-01-15T10:30:46.456Z WARNING: Slow query detected (>500ms)
┃ 2024-01-15T10:30:47.789Z ERROR: Connection refused: database unavailable
```

--------------------------------

### Create .python-version file

Source: https://fastapicloud.com/docs/getting-started/existing-project/

Create a .python-version file in the project root to specify the Python version. This example uses version 3.12.

```text
3.12

```

--------------------------------

### Interactive set command output

Source: https://fastapicloud.com/docs/fastapi-cloud-cli/env/

Example output when running the set command interactively.

```text
Enter the name of the environment variable to set: API_KEY
Enter the value of the environment variable to set: [hidden]
Environment variable API_KEY set.
```

--------------------------------

### Install Logfire with FastAPI support

Source: https://fastapicloud.com/docs/integrations/logfire-integration/

Run this command in a terminal to add the logfire package with FastAPI support to your project.

```bash
uv add "logfire[fastapi]"
```

--------------------------------

### Serve frontend with app.frontend()

Source: https://fastapicloud.com/docs/builds-and-deployments/frontend/

Use app.frontend() to serve static files from a dist/ directory. The example assumes the frontend build files are in dist/, but you should use your actual directory name (e.g., build/ or out/) in app.frontend(), .gitignore, and .fastapicloudignore.

```python
from fastapi import FastAPI

app = FastAPI()


@app.get("/api/health")
def health():
    return {"status": "ok"}


app.frontend("/", directory="dist")

```

--------------------------------

### Create project with fastapi-new and custom Python version

Source: https://fastapicloud.com/docs/getting-started/

Use the -p/--python option to specify a Python version for the new project. The example uses Python 3.11.

```bash
uvx fastapi-new myapp --python 3.11
cd myapp
```

--------------------------------

### GitHub Actions workflow for deploying with frontend build

Source: https://fastapicloud.com/docs/builds-and-deployments/frontend/

Use this workflow to deploy a FastAPI Cloud app with a frontend from GitHub Actions. It adds 'Install Node.js' and 'Build the frontend' steps before deploying, since dist/ is git-ignored and must be built in CI. Adjust the npm install and build commands for your package manager.

```yaml
name: "Deploy"

on:
  push:
    branches:
      - main
  workflow_dispatch:

jobs:
  deploy:
    name: "Deploy"
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v5
        with:
          fetch-depth: 0

      - name: Install Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 24

      - name: Build the frontend
        run: |
          npm ci
          npm run build

      - name: Install the latest version of uv
        uses: astral-sh/setup-uv@v7

      - name: Deploy to FastAPI Cloud
        run: uv run fastapi deploy
        env:
          FASTAPI_CLOUD_TOKEN: ${{ secrets.FASTAPI_CLOUD_TOKEN }}
          FASTAPI_CLOUD_APP_ID: ${{ secrets.FASTAPI_CLOUD_APP_ID }}
```

--------------------------------

### Example .fastapicloudignore file

Source: https://fastapicloud.com/docs/getting-started/existing-project/

Create a .fastapicloudignore file in your project root to customize which files are uploaded. It uses the same syntax as .gitignore but takes precedence. Use '!' to un-ignore files that are in .gitignore, useful for build outputs.

```plaintext
# Ignore additional files not in .gitignore
tests/
data/
*.csv

# Un-ignore files that are in .gitignore (useful for build outputs)
!dist/
```

--------------------------------

### Initialize project with uv

Source: https://fastapicloud.com/docs/getting-started/

Initialize a new project using uv and enter the directory.

```bash
uv init myapp
cd myapp
```

--------------------------------

### Initialize project with pip

Source: https://fastapicloud.com/docs/getting-started/

Create a project directory, enter it, and create a virtual environment with Python's venv module.

```bash
mkdir myapp
cd myapp
python -m venv .venv
```

--------------------------------

### Use Redis Cloud with REDIS_URL in cache.py

Source: https://fastapicloud.com/docs/integrations/redis-integration/

Example of using the Redis Cloud connection via the REDIS_URL environment variable. The URL is automatically injected, and the code demonstrates setting and getting values, including a cached value with a 10-minute expiration.

```python
import redis.asyncio as redis
import os

# The Redis URL is automatically injected as an environment variable
REDIS_URL = os.getenv("REDIS_URL")


async def get_redis_client():
    return redis.from_url(REDIS_URL)


async def cache_example():
    client = await get_redis_client()

    await client.set("key", "value")
    value = await client.get("key")

    await client.set("cache:data", "cached_value", ex=timedelta(minutes=10))

    # Clean up
    await client.close()
```

--------------------------------

### Usage: fastapi cloud setup-ci [OPTIONS]

Source: https://fastapicloud.com/docs/fastapi-cloud-cli/setup-ci/

Shows the command syntax for `fastapi cloud setup-ci`. Options include `--branch`/`-b`, `--secrets-only`/`-s`, `--dry-run`/`-d`, and `--file`/`-f`.

```bash
fastapi cloud setup-ci [OPTIONS]
```

--------------------------------

### Create project with fastapi-new

Source: https://fastapicloud.com/docs/getting-started/

Run uvx fastapi-new to scaffold a new FastAPI project and enter the directory. This adds fastapi[standard] as a dependency, which includes the FastAPI Cloud CLI.

```bash
uvx fastapi-new myapp
cd myapp
```

--------------------------------

### Preview Without Making Changes: fastapi cloud setup-ci --dry-run

Source: https://fastapicloud.com/docs/fastapi-cloud-cli/setup-ci/

Uses the `--dry-run` flag to preview what would happen without making any changes.

```bash
fastapi cloud setup-ci --dry-run
```

--------------------------------

### Use a Custom Workflow Filename: fastapi cloud setup-ci --file deploy-prod.yml

Source: https://fastapicloud.com/docs/fastapi-cloud-cli/setup-ci/

Writes the workflow file to `.github/workflows/deploy-prod.yml` using the `--file` option.

```bash
fastapi cloud setup-ci --file deploy-prod.yml
```

--------------------------------

### Typical project structure (top level)

Source: https://fastapicloud.com/docs/getting-started/existing-project/

Shows a standard project layout with `pyproject.toml` and `main.py` at the root.

```text
myproject/
├── pyproject.toml
├── main.py
└── ...
```

--------------------------------

### fastapi cloud setup-ci [OPTIONS]

Source: https://fastapicloud.com/docs/fastapi-cloud-cli/setup-ci/

Configures GitHub Actions for continuous deployment by creating a deploy token, setting GitHub secrets, and writing a workflow file. Options allow overriding the deploy branch, setting secrets only, previewing changes, and customizing the workflow filename.

```APIDOC
## fastapi cloud setup-ci [OPTIONS]

### Description
Configures GitHub Actions for continuous deployment of your FastAPI Cloud application. It creates a deploy token, sets the required GitHub secrets, and writes a workflow file — all in one step.

### Method
CLI Command

### Endpoint
`fastapi cloud setup-ci`

### Parameters
#### Options
- `--branch`, `-b` (string) - Optional - Override the deploy branch (default: `main`)
- `--secrets-only`, `-s` (flag) - Optional - Set secrets only, skip writing the workflow file
- `--dry-run`, `-d` (flag) - Optional - Preview what would happen without making changes
- `--file`, `-f` (string) - Optional - Custom workflow filename (written to `.github/workflows/<name>`)

### Request Example
```
fastapi cloud setup-ci
```

### Response
#### Success Response
- No direct response body; the command performs actions and prints output.

#### Response Example
```
(No explicit response example provided)
```

### Examples
#### Run with Defaults
```
fastapi cloud setup-ci
```

#### Target a Specific Branch
```
fastapi cloud setup-ci --branch production
```

#### Preview Without Making Changes
```
fastapi cloud setup-ci --dry-run
```

#### Set Secrets Only
```
fastapi cloud setup-ci --secrets-only
```

#### Use a Custom Workflow Filename
```
fastapi cloud setup-ci --file deploy-prod.yml
```

```

--------------------------------

### Comments in .env format

Source: https://fastapicloud.com/docs/builds-and-deployments/environment-variables/

Lines starting with # are treated as comments and ignored during import. Use this to add notes or organize your .env file.

```plaintext
# Database configuration
DATABASE_URL=postgresql://localhost/mydb
# API settings
API_KEY=your_api_key_here
```

--------------------------------

### Fetch recent logs without streaming with --no-follow

Source: https://fastapicloud.com/docs/fastapi-cloud-cli/logs/

Fetches the recent logs and exits immediately. Use this to get a snapshot of logs without continuous streaming.

```bash
fastapi cloud logs --no-follow
```

--------------------------------

### Stream logs in real-time with fastapi cloud logs

Source: https://fastapicloud.com/docs/fastapi-cloud-cli/logs/

Starts streaming logs continuously until Ctrl+C is pressed. The output shows a header line and log lines with timestamp, level, and message.

```bash
fastapi cloud logs
```

```bash
logs Streaming logs for fastapi-rules-app (Ctrl+C to exit)...
─────
┃ 2024-01-15T10:30:45.123Z INFO: Application startup complete.
┃ 2024-01-15T10:30:46.456Z INFO: GET /health 200 OK
┃ 2024-01-15T10:30:47.789Z INFO: POST /items 201 Created
```

--------------------------------

### Pin exact Python version in pyproject.toml

Source: https://fastapicloud.com/docs/getting-started/existing-project/

Pin a specific Python version using the requires-python field, useful when dependencies don't support the latest Python. This example pins to 3.12.*.

```toml
requires-python = "==3.12.*"

```

--------------------------------

### Create main.py with FastAPI app

Source: https://fastapicloud.com/docs/getting-started/

Create a file named main.py with a basic FastAPI application that returns a JSON message at the root path.

```python
from fastapi import FastAPI

app = FastAPI()


@app.get("/")
def main():
    return {"message": "Hello World"}
```

--------------------------------

### Specify Python version with requires-python in pyproject.toml

Source: https://fastapicloud.com/docs/builds-and-deployments/install-dependencies/

Use this pyproject.toml snippet to require Python 3.12 or higher for your application. FastAPI Cloud will use the specified version to install and run your app.

```TOML
[project]
name = "app"
version = "0.1.0"
description = "My awesome app"
requires-python = ">=3.12"

```

--------------------------------

### Configure custom entrypoint in pyproject.toml

Source: https://fastapicloud.com/docs/builds-and-deployments/configuring-fastapi/

Add this `[tool.fastapi]` section to your `pyproject.toml` to set the entrypoint. It tells the `fastapi` command to import the `app` object from the `my_app.main` module (the file `my_app/main.py`).

```toml
[tool.fastapi]
entrypoint = "my_app.main:app"
```

--------------------------------

### Upgrade FastAPI with standard extras

Source: https://fastapicloud.com/docs/monitoring-and-performance/metrics/

Run this command to upgrade FastAPI to version 0.142.0 or higher with the standard extras, enabling automatic OpenTelemetry metrics. If you previously used the OpenTelemetry integration, remove the FastAPIInstrumentor.instrument_app(app) call and MeterProvider setup.

```bash
$ uv add "fastapi[standard]>=0.142.0" --upgrade
```

--------------------------------

### Use DATABASE_URL with SQLModel in FastAPI

Source: https://fastapicloud.com/docs/integrations/neon-integration/

Example of using the Neon database connection via the DATABASE_URL environment variable in a FastAPI app with SQLModel. The engine is created from the environment variable, and the app defines a Hero model, creates tables on startup, and provides endpoints to create and read heroes.

```python
import os

from fastapi import FastAPI
from sqlmodel import Field, Session, SQLModel, create_engine, select


class Hero(SQLModel, table=True):
    id: int | None = Field(default=None, primary_key=True)
    name: str = Field(index=True)
    secret_name: str
    age: int | None = Field(default=None, index=True)


# The database URL is automatically injected as an environment variable
engine = create_engine(os.getenv("DATABASE_URL"))


def create_db_and_tables():
    SQLModel.metadata.create_all(engine)


app = FastAPI()


@app.on_event("startup")
def on_startup():
    create_db_and_tables()


@app.post("/heroes/")
def create_hero(hero: Hero):
    with Session(engine) as session:
        session.add(hero)
        session.commit()
        session.refresh(hero)
        return hero


@app.get("/heroes/")
def read_heroes():
    with Session(engine) as session:
        heroes = session.exec(select(Hero)).all()
        return heroes
```

--------------------------------

### Equivalent Python import for the entrypoint

Source: https://fastapicloud.com/docs/builds-and-deployments/configuring-fastapi/

This is the Python import equivalent to the `entrypoint` configuration. It shows that `my_app.main:app` corresponds to `from my_app.main import app`.

```python
from my_app.main import app
```

--------------------------------

### Add fastapi[standard] with uv

Source: https://fastapicloud.com/docs/getting-started/existing-project/

Command to add `fastapi[standard]` using the uv package manager.

```bash
uv add "fastapi[standard]"
```

--------------------------------

### fastapi cloud env usage

Source: https://fastapicloud.com/docs/fastapi-cloud-cli/env/

Shows the general syntax for the env command with subcommands and options.

```bash
fastapi cloud env [COMMAND] [OPTIONS]
```

--------------------------------

### Run uvx migrate-to-uv to migrate to uv

Source: https://fastapicloud.com/docs/getting-started/existing-project/

Run this command in a terminal to migrate an existing project from Poetry, Pipenv, or pip to uv. It reads your configuration files and updates them to use uv, generating a new uv.lock file.

```bash
uvx migrate-to-uv
```

--------------------------------

### Activate virtual environment on Linux/macOS

Source: https://fastapicloud.com/docs/getting-started/

Activate the virtual environment created by fastapi-new on Linux or macOS.

```bash
source .venv/bin/activate
```
Tokens:
Raw