Deploy Edge Functions from CLI without needing Docker + import files outside of supabase directory

[laktek]

We've introduced an experimental flag to the Supabase CLI, which allows you to deploy Edge Functions without running Docker.

How to use

npx supabase@beta functions deploy --use-api

This also simplifies importing files outside the supabase/ directory within Edge Functions. Useful for monorepo setups where you want to share code between your frontend and Edge Functions.

For example, Given the directory layout below, you can import my-lib from either index.ts or deno.json.

my-repo/
├─ my-app/
│  ├─ supabase/
│  │  │  functions/
│  │  │  │  slug/
│  │  │  │  ├─ index.ts
│  │  │  │  ├─ deno.json
├─ my-lib/
│  ├─ src/
│  │  ├─ index.ts
├─ README.md

The new flag is available from the Supabase CLI beta releases 2.13.3. Please check CLI upgrade guide on how to use the beta releases on your machine.

CI

We also recommend using the --use-api flag if you deploy Edge Functions via CI. This should speed up the deploys as it no longer requires Docker and also solves a race condition previously occurred when deploying multiple functions in parallel.

Here's an example GitHub Action config:

name: Deploy Function

on:
  push:
    branches:
      - main
  workflow_dispatch:

jobs:
  deploy:
    runs-on: ubuntu-latest

    env:
      SUPABASE_ACCESS_TOKEN: ${{ secrets.SUPABASE_ACCESS_TOKEN }}
      PROJECT_ID: your-project-id

    steps:
      - uses: actions/checkout@v3

      - uses: supabase/setup-cli@v1
        with:
          version: 2.13.3

      - run: supabase functions deploy --use-api --project-ref $PROJECT_ID

Note: If you run into any issues with the --use-api, you can drop the flag to use the default Docker-based deploy mechanism.

Note 2: To run/ test Edge Functions locally (supabase functions serve), you will still need Docker. This only modifies deploy behavior.

[landsman]

Run supabase/setup-cli@v1
  with:
    version: beta
Error: Invalid Version: beta

[landsman]

I tried v2 with no effect. Then I realized that there is missing branch for v2.x: https://github.com/supabase/setup-cli/branches/all

Please check it with the team.

[laktek]

cc: @sweatybridge

[sweatybridge]

      - uses: supabase/setup-cli@v1
        with:
          version: 2.13.3

It should work if you pin the specific version exactly as above. The latest tag will be updated next week.

[landsman]

Deploy work with that tag.

Can you guys please create example repository for this feature for importing outside the supabase? I was not able to make it work properly.

It would help me a lot more than documentation.

[laktek]

@landsman Yes, a good idea! Will put together an example repo.

[mazeincoding]

Found an issue trying the new --use-api flag on Windows.

Running npx supabase@beta functions deploy cleanup-expired-sessions --use-api (CLI version 2.13.4) returns:

unexpected deploy status 400: {"message":"Entrypoint path does not exist - /tmp/user_fn_rqsfebcljeizuojtkabi_2c51519f-dff7-44cd-a019-bcd259144f1e_5/supabase\functions\cleanup-expired-sessions\index.ts"}

Looks like the server isn't handling Windows path separators () correctly when processing the uploaded files. The path in the error message shows a mix of forward and backslashes.

I tried both with and without the --project-ref flag, same result. Removing --use-api (using Docker) works fine.

[laktek]

Thanks for reporting this! we will fix it soon.

[landsman]

@mazeincoding I recommend to use WLS. This kind of thing is a problem in a lot of software. Majority of software is made on linux / unix.

[sweatybridge]

We've released a fix for windows path in v2.13.8. Please try again using npx supabase@beta if you can.