mirror of
https://github.com/supabase/supabase.git
synced 2026-10-08 10:55:06 +03:00
764 lines
22 KiB
YAML
764 lines
22 KiB
YAML
clispec: '001'
|
|
info:
|
|
id: cli
|
|
version: 1.14.3
|
|
title: Supabase CLI
|
|
language: sh
|
|
source: https://github.com/supabase/cli
|
|
bugs: https://github.com/supabase/cli/issues
|
|
spec: https://github.com/supabase/supabase.tools/cli_spec/lib.yaml
|
|
description: |
|
|
Supabase CLI provides you with tools to develop your application locally, and deploy your application to the Supabase platform.
|
|
tags:
|
|
- id: local-dev
|
|
title: Local Development
|
|
- id: management-api
|
|
title: Management APIs
|
|
- id: other-commands
|
|
title: Additional Commands
|
|
flags:
|
|
- id: debug
|
|
name: --debug
|
|
description: output debug logs to stderr
|
|
default_value: 'false'
|
|
- id: experimental
|
|
name: --experimental
|
|
description: enable experimental features
|
|
default_value: 'false'
|
|
- id: help
|
|
name: -h, --help
|
|
description: help for supabase
|
|
default_value: 'false'
|
|
- id: workdir
|
|
name: --workdir <string>
|
|
description: path to a Supabase project directory
|
|
default_value: ''
|
|
commands:
|
|
- id: supabase-test
|
|
title: supabase test
|
|
summary: Run tests on local Supabase containers
|
|
tags:
|
|
- local-dev
|
|
links: []
|
|
subcommands:
|
|
- supabase-test-db
|
|
flags: []
|
|
- id: supabase-test-db
|
|
title: supabase test db
|
|
summary: Tests local database with pgTAP
|
|
tags: []
|
|
links: []
|
|
usage: supabase test db
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-stop
|
|
title: supabase stop
|
|
summary: Stop all local Supabase containers
|
|
tags:
|
|
- local-dev
|
|
links: []
|
|
usage: supabase stop [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: backup
|
|
name: --backup
|
|
description: Backs up the current database before stopping.
|
|
default_value: 'false'
|
|
- id: supabase-status
|
|
title: supabase status
|
|
summary: Show status of local Supabase containers
|
|
tags:
|
|
- local-dev
|
|
links: []
|
|
usage: supabase status [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: output
|
|
name: -o, --output <string>
|
|
description: Output format of status variables.
|
|
default_value: pretty
|
|
accepted_values:
|
|
- id: env
|
|
name: env
|
|
type: string
|
|
- id: json
|
|
name: json
|
|
type: string
|
|
- id: pretty
|
|
name: pretty
|
|
type: string
|
|
- id: toml
|
|
name: toml
|
|
type: string
|
|
- id: yaml
|
|
name: yaml
|
|
type: string
|
|
- id: override-name
|
|
name: --override-name <strings>
|
|
description: Override specific variable names.
|
|
default_value: '[]'
|
|
- id: supabase-start
|
|
title: supabase start
|
|
summary: Start containers for Supabase local development
|
|
tags:
|
|
- local-dev
|
|
links: []
|
|
usage: supabase start
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-secrets
|
|
title: supabase secrets
|
|
summary: Manage Supabase secrets
|
|
tags:
|
|
- management-api
|
|
links: []
|
|
subcommands:
|
|
- supabase-secrets-list
|
|
- supabase-secrets-set
|
|
- supabase-secrets-unset
|
|
flags: []
|
|
- id: supabase-secrets-unset
|
|
title: supabase secrets unset
|
|
summary: Unset a secret(s) on Supabase
|
|
description: Unset a secret(s) from the linked Supabase project.
|
|
tags: []
|
|
links: []
|
|
usage: supabase secrets unset <NAME> ...
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-secrets-set
|
|
title: supabase secrets set
|
|
summary: Set a secret(s) on Supabase
|
|
description: Set a secret(s) to the linked Supabase project.
|
|
tags: []
|
|
links: []
|
|
usage: supabase secrets set [flags] <NAME=VALUE> ...
|
|
subcommands: []
|
|
flags:
|
|
- id: env-file
|
|
name: --env-file <string>
|
|
description: Read secrets from a .env file.
|
|
default_value: ''
|
|
- id: supabase-secrets-list
|
|
title: supabase secrets list
|
|
summary: List all secrets on Supabase
|
|
description: List all secrets in the linked project.
|
|
tags: []
|
|
links: []
|
|
usage: supabase secrets list
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-projects
|
|
title: supabase projects
|
|
summary: Manage Supabase projects
|
|
tags:
|
|
- management-api
|
|
links: []
|
|
subcommands:
|
|
- supabase-projects-create
|
|
- supabase-projects-list
|
|
flags: []
|
|
- id: supabase-projects-list
|
|
title: supabase projects list
|
|
summary: List all Supabase projects
|
|
description: List all Supabase projects the logged-in user can access.
|
|
tags: []
|
|
links: []
|
|
usage: supabase projects list
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-projects-create
|
|
title: supabase projects create
|
|
summary: Create a project on Supabase
|
|
tags: []
|
|
links: []
|
|
usage: supabase projects create <project name> [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: db-password
|
|
name: --db-password <string>
|
|
description: Database password of the project.
|
|
default_value: ''
|
|
- id: interactive
|
|
name: -i, --interactive
|
|
description: Enables interactive mode.
|
|
default_value: 'false'
|
|
- id: org-id
|
|
name: --org-id <string>
|
|
description: Organization ID to create the project in.
|
|
default_value: ''
|
|
- id: plan
|
|
name: --plan <string>
|
|
description: Select a plan that suits your needs.
|
|
default_value: free
|
|
accepted_values:
|
|
- id: free
|
|
name: free
|
|
type: string
|
|
- id: pro
|
|
name: pro
|
|
type: string
|
|
- id: region
|
|
name: --region <string>
|
|
description: Select a region close to you for the best performance.
|
|
default_value: ''
|
|
accepted_values:
|
|
- id: ca-central-1
|
|
name: ca-central-1
|
|
type: string
|
|
- id: eu-west-2
|
|
name: eu-west-2
|
|
type: string
|
|
- id: us-east-1
|
|
name: us-east-1
|
|
type: string
|
|
- id: ap-south-1
|
|
name: ap-south-1
|
|
type: string
|
|
- id: ap-southeast-1
|
|
name: ap-southeast-1
|
|
type: string
|
|
- id: ap-southeast-2
|
|
name: ap-southeast-2
|
|
type: string
|
|
- id: eu-west-1
|
|
name: eu-west-1
|
|
type: string
|
|
- id: sa-east-1
|
|
name: sa-east-1
|
|
type: string
|
|
- id: us-west-1
|
|
name: us-west-1
|
|
type: string
|
|
- id: ap-northeast-1
|
|
name: ap-northeast-1
|
|
type: string
|
|
- id: ap-northeast-2
|
|
name: ap-northeast-2
|
|
type: string
|
|
- id: eu-central-1
|
|
name: eu-central-1
|
|
type: string
|
|
- id: supabase-orgs
|
|
title: supabase orgs
|
|
summary: Manage Supabase organizations
|
|
tags:
|
|
- management-api
|
|
links: []
|
|
subcommands:
|
|
- supabase-orgs-list
|
|
flags: []
|
|
- id: supabase-orgs-list
|
|
title: supabase orgs list
|
|
summary: List all organizations
|
|
description: List all organizations the logged-in user belongs.
|
|
tags: []
|
|
links: []
|
|
usage: supabase orgs list
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-migration
|
|
title: supabase migration
|
|
summary: Manage database migration scripts
|
|
tags:
|
|
- local-dev
|
|
links: []
|
|
subcommands:
|
|
- supabase-migration-list
|
|
- supabase-migration-new
|
|
flags: []
|
|
- id: supabase-migration-new
|
|
title: supabase migration new
|
|
summary: Create an empty migration script
|
|
tags: []
|
|
links: []
|
|
usage: supabase migration new <migration name>
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-migration-list
|
|
title: supabase migration list
|
|
summary: List local and remote migrations
|
|
tags: []
|
|
links: []
|
|
usage: supabase migration list [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: password
|
|
name: -p, --password <string>
|
|
description: Password to your remote Postgres database.
|
|
default_value: ''
|
|
- id: supabase-login
|
|
title: supabase login
|
|
summary: Authenticate using an access token
|
|
tags:
|
|
- local-dev
|
|
links: []
|
|
usage: supabase login
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-link
|
|
title: supabase link
|
|
summary: Link to a Supabase project
|
|
tags:
|
|
- local-dev
|
|
links: []
|
|
usage: supabase link [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: password
|
|
name: -p, --password <string>
|
|
description: Password to your remote Postgres database.
|
|
default_value: ''
|
|
- id: project-ref
|
|
name: --project-ref <string>
|
|
description: Project ref of the Supabase project.
|
|
required: true
|
|
default_value: ''
|
|
- id: supabase-init
|
|
title: supabase init
|
|
summary: Initialize a local project
|
|
tags:
|
|
- local-dev
|
|
links: []
|
|
usage: supabase init
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-gen
|
|
title: supabase gen
|
|
summary: Run code generation tools
|
|
tags:
|
|
- local-dev
|
|
links: []
|
|
subcommands:
|
|
- supabase-gen-types
|
|
flags: []
|
|
- id: supabase-gen-types
|
|
title: supabase gen types
|
|
summary: Generate types from Postgres schema
|
|
tags: []
|
|
links: []
|
|
subcommands:
|
|
- supabase-gen-types-typescript
|
|
flags: []
|
|
- id: supabase-gen-types-typescript
|
|
title: supabase gen types typescript
|
|
summary: Generate types for TypeScript
|
|
description: |
|
|
Generate types for TypeScript. Must specify one of --local, --linked, --project-id, or --db-url
|
|
tags: []
|
|
links: []
|
|
usage: supabase gen types typescript [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: db-url
|
|
name: --db-url <string>
|
|
description: Generate types from a database url.
|
|
default_value: ''
|
|
- id: linked
|
|
name: --linked
|
|
description: Generate types from the linked project.
|
|
default_value: 'false'
|
|
- id: local
|
|
name: --local
|
|
description: Generate types from the local dev database.
|
|
default_value: 'false'
|
|
- id: project-id
|
|
name: --project-id <string>
|
|
description: Generate types from a project ID.
|
|
default_value: ''
|
|
- id: schema
|
|
name: --schema <stringArray>
|
|
description: Schemas to generate types for.
|
|
default_value: '[]'
|
|
- id: supabase-functions
|
|
title: supabase functions
|
|
summary: Manage Supabase Edge functions
|
|
tags:
|
|
- management-api
|
|
links: []
|
|
subcommands:
|
|
- supabase-functions-delete
|
|
- supabase-functions-deploy
|
|
- supabase-functions-new
|
|
- supabase-functions-serve
|
|
flags: []
|
|
- id: supabase-functions-serve
|
|
title: supabase functions serve
|
|
summary: Serve a Function locally
|
|
tags: []
|
|
links: []
|
|
usage: supabase functions serve <Function name> [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: env-file
|
|
name: --env-file <string>
|
|
description: |
|
|
Path to an env file to be populated to the Function environment.
|
|
default_value: ''
|
|
- id: no-verify-jwt
|
|
name: --no-verify-jwt
|
|
description: Disable JWT verification for the Function.
|
|
default_value: 'false'
|
|
- id: supabase-functions-new
|
|
title: supabase functions new
|
|
summary: Create a new Function locally
|
|
tags: []
|
|
links: []
|
|
usage: supabase functions new <Function name>
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-functions-deploy
|
|
title: supabase functions deploy
|
|
summary: Deploy a Function to Supabase
|
|
description: Deploy a Function to the linked Supabase project.
|
|
tags: []
|
|
links: []
|
|
usage: supabase functions deploy <Function name> [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: legacy-bundle
|
|
name: --legacy-bundle
|
|
description: Use legacy bundling mechanism.
|
|
default_value: 'false'
|
|
- id: no-verify-jwt
|
|
name: --no-verify-jwt
|
|
description: Disable JWT verification for the Function.
|
|
default_value: 'false'
|
|
- id: project-ref
|
|
name: --project-ref <string>
|
|
description: Project ref of the Supabase project.
|
|
default_value: ''
|
|
- id: supabase-functions-delete
|
|
title: supabase functions delete
|
|
summary: Delete a Function from Supabase
|
|
description: |
|
|
Delete a Function from the linked Supabase project. This does NOT remove the Function locally.
|
|
tags: []
|
|
links: []
|
|
usage: supabase functions delete <Function name> [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: project-ref
|
|
name: --project-ref <string>
|
|
description: Project ref of the Supabase project.
|
|
default_value: ''
|
|
- id: supabase-domains
|
|
title: supabase domains
|
|
summary: Manage custom domain names for Supabase projects
|
|
tags:
|
|
- management-api
|
|
links: []
|
|
subcommands:
|
|
- supabase-domains-activate
|
|
- supabase-domains-create
|
|
- supabase-domains-delete
|
|
- supabase-domains-get
|
|
- supabase-domains-reverify
|
|
flags:
|
|
- id: include-raw-output
|
|
name: --include-raw-output
|
|
description: Include raw output (useful for debugging).
|
|
default_value: 'false'
|
|
- id: project-ref
|
|
name: --project-ref <string>
|
|
description: Project ref of the Supabase project.
|
|
default_value: ''
|
|
- id: supabase-domains-reverify
|
|
title: supabase domains reverify
|
|
summary: Re-verify the custom hostname config for your project.
|
|
tags: []
|
|
links: []
|
|
usage: supabase domains reverify
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-domains-get
|
|
title: supabase domains get
|
|
summary: Get the current custom hostname config.
|
|
description: |
|
|
Retrieve the custom hostname config for your project, as stored in the Supabase platform.
|
|
tags: []
|
|
links: []
|
|
usage: supabase domains get
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-domains-delete
|
|
title: supabase domains delete
|
|
summary: Deletes the custom hostname config for your project.
|
|
tags: []
|
|
links: []
|
|
usage: supabase domains delete
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-domains-create
|
|
title: supabase domains create
|
|
summary: Create a custom hostname.
|
|
description: |-
|
|
Create a custom hostname for your Supabase project.
|
|
|
|
Expects your custom hostname to have a CNAME record to your Supabase project's subdomain.
|
|
tags: []
|
|
links: []
|
|
usage: supabase domains create [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: custom-hostname
|
|
name: --custom-hostname <string>
|
|
description: The custom hostname to use for your Supabase project.
|
|
default_value: ''
|
|
- id: supabase-domains-activate
|
|
title: supabase domains activate
|
|
summary: Activate the custom hostname for a project.
|
|
description: |-
|
|
Activates the custom hostname configuration for a project.
|
|
|
|
This reconfigures your Supabase project to respond to requests on your custom hostname.
|
|
After the custom hostname is activated, your project's auth services will no longer function on the Supabase-provisioned subdomain.
|
|
tags: []
|
|
links: []
|
|
usage: supabase domains activate
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-db
|
|
title: supabase db
|
|
summary: Manage local Postgres databases
|
|
tags:
|
|
- local-dev
|
|
links: []
|
|
subcommands:
|
|
- supabase-db-diff
|
|
- supabase-db-lint
|
|
- supabase-db-push
|
|
- supabase-db-remote
|
|
- supabase-db-reset
|
|
flags: []
|
|
- id: supabase-db-reset
|
|
title: supabase db reset
|
|
summary: Resets the local database to current migrations
|
|
tags: []
|
|
links: []
|
|
usage: supabase db reset
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-db-remote
|
|
title: supabase db remote
|
|
summary: Manage remote databases
|
|
tags: []
|
|
links: []
|
|
subcommands:
|
|
- supabase-db-remote-changes
|
|
- supabase-db-remote-commit
|
|
flags:
|
|
- id: password
|
|
name: -p, --password <string>
|
|
description: Password to your remote Postgres database.
|
|
default_value: ''
|
|
- id: supabase-db-remote-commit
|
|
title: supabase db remote commit
|
|
summary: Commit remote changes as a new migration
|
|
tags: []
|
|
links: []
|
|
usage: supabase db remote commit
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-db-remote-changes
|
|
title: supabase db remote changes
|
|
summary: Show changes on the remote database
|
|
description: Show changes on the remote database since last migration.
|
|
tags: []
|
|
links: []
|
|
usage: supabase db remote changes
|
|
subcommands: []
|
|
flags: []
|
|
- id: supabase-db-push
|
|
title: supabase db push
|
|
summary: Push new migrations to the remote database
|
|
tags: []
|
|
links: []
|
|
usage: supabase db push [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: dry-run
|
|
name: --dry-run
|
|
description: |
|
|
Print the migrations that would be applied, but don't actually apply them.
|
|
default_value: 'false'
|
|
- id: password
|
|
name: -p, --password <string>
|
|
description: Password to your remote Postgres database.
|
|
default_value: ''
|
|
- id: supabase-db-lint
|
|
title: supabase db lint
|
|
summary: Checks local database for typing error
|
|
tags: []
|
|
links: []
|
|
usage: supabase db lint [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: level
|
|
name: --level <string>
|
|
description: Error level to emit.
|
|
default_value: warning
|
|
accepted_values:
|
|
- id: warning
|
|
name: warning
|
|
type: string
|
|
- id: error
|
|
name: error
|
|
type: string
|
|
- id: schema
|
|
name: -s, --schema <strings>
|
|
description: List of schema to include.
|
|
default_value: '[public]'
|
|
- id: supabase-db-diff
|
|
title: supabase db diff
|
|
summary: Diffs the local database for schema changes
|
|
tags: []
|
|
links: []
|
|
usage: supabase db diff [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: file
|
|
name: -f, --file <string>
|
|
description: Saves schema diff to a file.
|
|
default_value: ''
|
|
- id: linked
|
|
name: --linked
|
|
description: Diffs local schema against linked project.
|
|
default_value: 'false'
|
|
- id: schema
|
|
name: -s, --schema <strings>
|
|
description: List of schema to include.
|
|
default_value: '[public]'
|
|
- id: use-migra
|
|
name: --use-migra
|
|
description: Use migra to generate schema diff.
|
|
default_value: 'false'
|
|
- id: supabase-completion
|
|
title: supabase completion
|
|
summary: Generate the autocompletion script for the specified shell
|
|
description: |
|
|
Generate the autocompletion script for supabase for the specified shell.
|
|
See each sub-command's help for details on how to use the generated script.
|
|
tags:
|
|
- other-commands
|
|
links: []
|
|
subcommands:
|
|
- supabase-completion-bash
|
|
- supabase-completion-fish
|
|
- supabase-completion-powershell
|
|
- supabase-completion-zsh
|
|
flags: []
|
|
- id: supabase-completion-zsh
|
|
title: supabase completion zsh
|
|
summary: Generate the autocompletion script for zsh
|
|
description: |
|
|
Generate the autocompletion script for the zsh shell.
|
|
|
|
If shell completion is not already enabled in your environment you will need
|
|
to enable it. You can execute the following once:
|
|
|
|
echo "autoload -U compinit; compinit" >> ~/.zshrc
|
|
|
|
To load completions in your current shell session:
|
|
|
|
source <(supabase completion zsh); compdef _supabase supabase
|
|
|
|
To load completions for every new session, execute once:
|
|
|
|
#### Linux:
|
|
|
|
supabase completion zsh > "${fpath[1]}/_supabase"
|
|
|
|
#### macOS:
|
|
|
|
supabase completion zsh > $(brew --prefix)/share/zsh/site-functions/_supabase
|
|
|
|
You will need to start a new shell for this setup to take effect.
|
|
tags: []
|
|
links: []
|
|
usage: supabase completion zsh [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: no-descriptions
|
|
name: --no-descriptions
|
|
description: disable completion descriptions
|
|
default_value: 'false'
|
|
- id: supabase-completion-powershell
|
|
title: supabase completion powershell
|
|
summary: Generate the autocompletion script for powershell
|
|
description: |
|
|
Generate the autocompletion script for powershell.
|
|
|
|
To load completions in your current shell session:
|
|
|
|
supabase completion powershell | Out-String | Invoke-Expression
|
|
|
|
To load completions for every new session, add the output of the above command
|
|
to your powershell profile.
|
|
tags: []
|
|
links: []
|
|
usage: supabase completion powershell [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: no-descriptions
|
|
name: --no-descriptions
|
|
description: disable completion descriptions
|
|
default_value: 'false'
|
|
- id: supabase-completion-fish
|
|
title: supabase completion fish
|
|
summary: Generate the autocompletion script for fish
|
|
description: |
|
|
Generate the autocompletion script for the fish shell.
|
|
|
|
To load completions in your current shell session:
|
|
|
|
supabase completion fish | source
|
|
|
|
To load completions for every new session, execute once:
|
|
|
|
supabase completion fish > ~/.config/fish/completions/supabase.fish
|
|
|
|
You will need to start a new shell for this setup to take effect.
|
|
tags: []
|
|
links: []
|
|
usage: supabase completion fish [flags]
|
|
subcommands: []
|
|
flags:
|
|
- id: no-descriptions
|
|
name: --no-descriptions
|
|
description: disable completion descriptions
|
|
default_value: 'false'
|
|
- id: supabase-completion-bash
|
|
title: supabase completion bash
|
|
summary: Generate the autocompletion script for bash
|
|
description: |
|
|
Generate the autocompletion script for the bash shell.
|
|
|
|
This script depends on the 'bash-completion' package.
|
|
If it is not installed already, you can install it via your OS's package manager.
|
|
|
|
To load completions in your current shell session:
|
|
|
|
source <(supabase completion bash)
|
|
|
|
To load completions for every new session, execute once:
|
|
|
|
#### Linux:
|
|
|
|
supabase completion bash > /etc/bash_completion.d/supabase
|
|
|
|
#### macOS:
|
|
|
|
supabase completion bash > $(brew --prefix)/etc/bash_completion.d/supabase
|
|
|
|
You will need to start a new shell for this setup to take effect.
|
|
tags: []
|
|
links: []
|
|
usage: supabase completion bash
|
|
subcommands: []
|
|
flags:
|
|
- id: no-descriptions
|
|
name: --no-descriptions
|
|
description: disable completion descriptions
|
|
default_value: 'false'
|