Skip to main content
skill CX Codex

supabase-cli — Claude Code skill: what it does, how to install

Equips coding agents to run Supabase CLI commands for local environments, schema migrations, edge function deployments, and TypeScript type generation.

MIT ★ 1,216 updated 2026-10-24

Install into Claude Code · Plugin marketplace All methods and platforms ↓
/plugin marketplace add fcakyon/claude-codex-settings
/plugin install supabase-skills@claude-settings
Open on GitHub

What supabase-cli does

Provides decision trees and command mappings for the supabase command-line utility. The agent receives structured steps to run supabase init, start local services with supabase start, check status, or stop containers without preserving data.

It handles database migrations and serverless functions directly in the workspace. Mappings cover schema diffing with supabase db diff, running pgTAP tests, pulling remote schemas, and creating TypeScript definitions with supabase gen types typescript. For edge functions, it details local serving with environment files and pushing updates to remote projects.

The supabase executable must already be installed on your machine through Homebrew, npm, or Scoop. Linking remote projects requires an access token configured through supabase login.

What it helps with

  • Spin up local Supabase containers and inspect running service endpoints
  • Generate TypeScript types directly from local or remote schemas
  • Create, serve locally, and deploy Supabase Edge Functions
  • Diff schema changes and manage database migrations

Example prompts for the agent

  • Start the local Supabase stack without studio and show status
  • Generate TypeScript types from my local database
  • Create a new edge function named auth-webhook and serve it locally

How to install supabase-cli

1Plugin marketplace

/plugin marketplace add fcakyon/claude-codex-settings
/plugin install supabase-skills@claude-settings

This installs the whole supabase-skills plugin with all its skills

2Skills CLI (Vercel)

npx skills add fcakyon/claude-codex-settings --skill supabase-cli -a claude-code

3Manually: put the files in place

~/.claude/skills/supabase-cli/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/supabase-cli/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about supabase-cli

How do I install supabase-cli in Claude Code?

Run /plugin marketplace add fcakyon/claude-codex-settings, followed by /plugin install supabase-skills@claude-settings. You can also run npx skills add fcakyon/claude-codex-settings --skill supabase-cli -a claude-code.

What does the supabase-cli skill do?

It guides your agent with exact Supabase CLI syntax for local stacks, migrations, project secrets, database inspection, and TypeScript code generation.

What prerequisites are required?

You need the supabase CLI tool installed on your machine via npm, Homebrew, or Scoop. Interacting with remote projects requires running supabase login.

Source text

SKILL.md · MIT
---
name: supabase-cli
description: This skill should be used when user asks to "use supabase CLI", "supabase init", "supabase start", "run migrations", "deploy edge functions", "manage Supabase project", or works with the supabase command-line tool for local development and project management.
references:
  - commands
  - db
  - migration
  - functions
license: MIT
---

# Supabase CLI Skill

Skill for local development, migrations, edge functions, and project management with the `supabase` CLI. Official docs: https://supabase.com/docs/reference/cli/about

## Installation

```bash
# macOS / Linux (Homebrew)
brew install supabase/tap/supabase

# npm
npm install -g supabase

# Windows (Scoop)
scoop bucket add supabase https://github.com/supabase/scoop-bucket.git
scoop install supabase
```

## Authentication

```bash
# Login with access token from https://supabase.com/dashboard/account/tokens
supabase login

# Link to a project
supabase link --project-ref <project-id>
```

## Quick Decision Trees

### "I need local development"

```
Local dev?
├─ Initialize project → supabase init
├─ Start local stack → supabase start
│  ├─ Without specific services → supabase start -x studio,imgproxy
│  └─ Status → supabase status
├─ Stop local stack → supabase stop
│  └─ Clean up data → supabase stop --no-backup
├─ View service URLs → supabase status
└─ Bootstrap from template → supabase bootstrap
```

### "I need database migrations"

```
Migrations?
├─ Create new migration → supabase migration new <name>
├─ Apply pending migrations → supabase migration up
│  └─ Rollback → supabase migration down
├─ Diff local changes → supabase db diff
│  └─ Save as migration → supabase db diff -f <name>
├─ Pull remote schema → supabase db pull
├─ Push local migrations → supabase db push
├─ Reset local database → supabase db reset
├─ List migrations → supabase migration list
├─ Squash migrations → supabase migration squash
├─ Run arbitrary SQL → supabase db query 'SELECT 1'
├─ Run pgTAP tests → supabase test db
└─ Lint schema → supabase db lint
```

### "I need edge functions"

```
Edge Functions?
├─ Create new function → supabase functions new <name>
├─ Serve locally → supabase functions serve
│  └─ With env file → supabase functions serve --env-file .env.local
├─ Deploy to project → supabase functions deploy <name>
│  └─ Deploy all → supabase functions deploy
├─ Delete function → supabase functions delete <name>
├─ List functions → supabase functions list
└─ Download function → supabase functions download <name>
```

### "I need to manage secrets"

```
Secrets?
├─ Set secrets → supabase secrets set KEY=value KEY2=value2
├─ Set from .env file → supabase secrets set --env-file .env
├─ List secrets → supabase secrets list
└─ Unset secrets → supabase secrets unset KEY KEY2
```

### "I need code generation"

```
Code gen?
├─ TypeScript types from DB → supabase gen types typescript --project-id <id>
│  └─ From local DB → supabase gen types typescript --local
├─ Signing key → supabase gen signing-key
└─ Bearer JWT → supabase gen bearer-jwt --project-ref <ref>
```

### "I need to inspect the database"

```
Inspect?
├─ Database stats → supabase inspect db db-stats
├─ Slow queries → supabase inspect db outliers
├─ Lock monitoring → supabase inspect db locks / blocking
├─ Long running queries → supabase inspect db long-running-queries
├─ Index analysis → supabase inspect db index-usage / unused-indexes
├─ Table sizes → supabase inspect db table-sizes / table-record-counts
├─ Cache hit ratio → supabase inspect db cache-hit
├─ Bloat → supabase inspect db bloat
├─ Vacuum stats → supabase inspect db vacuum-stats
└─ Replication slots → supabase inspect db replication-slots
```

### "I need project management"

```
Project management?
├─ Create project → supabase projects create <name> --org-id <id> --db-password <pw> --region <r>
├─ List projects → supabase projects list
├─ Delete project → supabase projects delete --project-ref <ref>
├─ API keys → supabase projects api-keys --project-ref <ref>
├─ Organizations → supabase orgs list / create
├─ Custom domains → supabase domains create / get / activate
├─ Preview branches → supabase branches create / list / delete
├─ Backups (PITR) → supabase backups list / restore
├─ SSO management → supabase sso add / list / remove
└─ Push config → supabase config push
```

## Common Workflows

### New project setup

```bash
supabase init
supabase start
# Make schema changes in Supabase Studio (http://127.0.0.1:54323)
supabase db diff -f initial_schema
supabase stop
```

### Migration workflow

```bash
# Create migration from local changes
supabase db diff -f add_profiles_table

# Or write SQL directly
supabase migration new add_profiles_table
# Edit supabase/migrations/<timestamp>_add_profiles_table.sql

# Test locally
supabase db reset
supabase test db

# Deploy to remote
supabase db push
```

### Edge function development

```bash
supabase functions new my-function
# Edit supabase/functions/my-function/index.ts
supabase functions serve  # local dev with hot reload
supabase functions deploy my-function
```

### Generate types after schema change

```bash
# From remote project
supabase gen types typescript --project-id <id> > database.types.ts

# From local running instance
supabase gen types typescript --local > database.types.ts
```

## Reference Index

| Category | Reference | Description |
|----------|-----------|-------------|
| Top-level commands | `references/commands/` | init, start, stop, status, login, link |
| Database | `references/db/` | diff, dump, lint, pull, push, reset, query |
| Migrations | `references/migration/` | list, new, repair, squash, up, down |
| Edge Functions | `references/functions/` | new, serve, deploy, delete |
| Inspect | `references/inspect/` | 20+ database inspection subcommands |
| Config | `references/config/` | push config to remote |
| Domains | `references/domains/` | custom domain management |
| Tests | `references/test/` | pgTAP database tests |
| Examples | `references/examples.yaml` | Usage examples for all commands |

© fcakyon · MIT · fcakyon/claude-codex-settings

Similar skills

All skills for Backend and APIs →

From the same set113

The whole set →
site-architecture The site-architecture skill for Claude Code and Codex plans or restructures site structure, including page hierarchy, navigation, URL patterns, breadcrumbs, and internal links. CX Codex +1 ★ 1,216repo stars derive-client derive-client records browser network traffic into a HAR archive and turns captured internal endpoints into a standalone API client or CLI script. CX Codex +1 ★ 1,216repo stars polar-local-environment The polar-local-environment skill for Claude Code manages Polar’s local Docker setup, including stack operations, service debugging, and separate environments for multiple worktrees. CX Codex +1 ★ 1,216repo stars yolo-training yolo-training reads YOLO26 training curves and results.csv, diagnoses overfitting or poor mAP, and points to the cheapest fix first. CX Codex +1 ★ 1,216repo stars payment-testing The payment-testing rule explains local checks for login, Stripe events, subscription renewals, refunds, and the backoffice. Use it when a payment flow behaves differently in your local stack. CX Codex +1 ★ 1,216repo stars troubleshooting troubleshooting — a rule covering common failures in a Dockerized Polar dev stack, from stuck ports to stale database connections. CX Codex +1 ★ 1,216repo stars supabase-js Adds practical cheat sheets and patterns for @supabase/supabase-js to your AI coding agent, covering Auth, Storage, Edge Functions, and queries. CX Codex +1 ★ 1,216repo stars create-pr The create-pr skill checks a branch, prepares a review-ready pull request, and publishes it with gh. Use it when you want an agent to handle the PR workflow for your changes. CX Codex +1 ★ 1,216repo stars

Project sponsors

Companies that keep this analytics open