clispec: '001' info: id: cli version: 1.123.0 title: Supabase CLI language: sh source: https://github.com/supabase/cli bugs: https://github.com/supabase/cli/issues spec: https://github.com/supabase/spec/cli_v1_commands.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: dns-resolver name: --dns-resolver <[ native | https ]> description: lookup domain names using the specified resolver default_value: native accepted_values: - id: native name: native type: '[ native | https ]' - id: https name: https type: '[ native | https ]' - 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 description: path to a Supabase project directory default_value: '' commands: - id: supabase-vanity-subdomains title: supabase vanity-subdomains summary: Manage vanity subdomains for Supabase projects description: |- Manage vanity subdomains for Supabase projects. Usage of vanity subdomains and custom domains is mutually exclusive. tags: - management-api links: [] subcommands: - supabase-vanity-subdomains-activate - supabase-vanity-subdomains-check-availability - supabase-vanity-subdomains-delete - supabase-vanity-subdomains-get flags: [] - id: supabase-vanity-subdomains-get title: supabase vanity-subdomains get summary: Get the current vanity subdomain tags: [] links: [] usage: supabase vanity-subdomains get subcommands: [] flags: - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-vanity-subdomains-delete title: supabase vanity-subdomains delete summary: Deletes a project's vanity subdomain description: | Deletes the vanity subdomain for a project, and reverts to using the project ref for routing. tags: [] links: [] usage: supabase vanity-subdomains delete subcommands: [] flags: - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-vanity-subdomains-check-availability title: supabase vanity-subdomains check-availability summary: Checks if a desired subdomain is available for use tags: [] links: [] usage: supabase vanity-subdomains check-availability [flags] subcommands: [] flags: - id: desired-subdomain name: --desired-subdomain description: | The desired vanity subdomain to use for your Supabase project. default_value: '' - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-vanity-subdomains-activate title: supabase vanity-subdomains activate summary: Activate a vanity subdomain description: | Activate a vanity subdomain for your Supabase project. This reconfigures your Supabase project to respond to requests on your vanity subdomain. After the vanity subdomain is activated, your project's auth services will no longer function on the {project-ref}.{supabase-domain} hostname. tags: [] links: [] usage: supabase vanity-subdomains activate [flags] subcommands: [] flags: - id: desired-subdomain name: --desired-subdomain description: | The desired vanity subdomain to use for your Supabase project. default_value: '' - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-test title: supabase test summary: Run tests on local Supabase containers tags: - local-dev links: [] subcommands: - supabase-test-db - supabase-test-new flags: [] - id: supabase-test-new title: supabase test new summary: Create a new test file tags: [] links: [] usage: supabase test new [flags] subcommands: [] flags: - id: template name: -t, --template <[ pgtap ]> description: Template framework to generate. default_value: pgtap accepted_values: - id: pgtap name: pgtap type: '[ pgtap ]' - id: supabase-test-db title: supabase test db summary: Tests local database with pgTAP description: |2 Executes pgTAP tests against the local database. Requires the local development stack to be started by running `supabase start`. Runs `pg_prove` in a container with unit test files volume mounted from `supabase/tests` directory. The test file can be suffixed by either `.sql` or `.pg` extension. Since each test is wrapped in its own transaction, it will be individually rolled back regardless of success or failure. examples: - id: basic-usage name: Basic usage code: supabase test db response: | /tmp/supabase/tests/nested/order_test.pg .. ok /tmp/supabase/tests/pet_test.sql .......... ok All tests successful. Files=2, Tests=2, 6 wallclock secs ( 0.03 usr 0.01 sys + 0.05 cusr 0.02 csys = 0.11 CPU) Result: PASS tags: [] links: [] usage: supabase test db subcommands: [] flags: [] - id: supabase-storage title: supabase storage summary: Manage Supabase Storage objects tags: - management-api links: [] subcommands: - supabase-storage-cp - supabase-storage-ls - supabase-storage-mv - supabase-storage-rm flags: [] - id: supabase-storage-rm title: supabase storage rm summary: Remove objects by file path tags: [] links: [] usage: supabase storage rm ... [flags] subcommands: [] flags: - id: recursive name: -r, --recursive description: Recursively remove a directory. default_value: 'false' - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: supabase-storage-mv title: supabase storage mv summary: Move objects from src to dst path tags: [] links: [] usage: supabase storage mv [flags] subcommands: [] flags: - id: recursive name: -r, --recursive description: Recursively move a directory. default_value: 'false' - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: supabase-storage-ls title: supabase storage ls summary: List objects by path prefix tags: [] links: [] usage: supabase storage ls [path] [flags] subcommands: [] flags: - id: recursive name: -r, --recursive description: Recursively list a directory. default_value: 'false' - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: supabase-storage-cp title: supabase storage cp summary: Copy objects from src to dst path tags: [] links: [] usage: supabase storage cp [flags] subcommands: [] flags: - id: recursive name: -r, --recursive description: Recursively copy a directory. default_value: 'false' - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: supabase-stop title: supabase stop summary: Stop all local Supabase containers description: |2 Stops the Supabase local development stack. Requires `supabase/config.toml` to be created in your current working directory by running `supabase init`. All Docker resources are maintained across restarts. Use `--no-backup` flag to reset your local development data between restarts. examples: - id: basic-usage name: Basic usage code: supabase stop response: | Stopped supabase local development setup. - id: with-backup name: Backup local database before stopping code: supabase stop --backup response: | Postgres database saved to volume: supabase_db_cli Storage directory saved to volume: supabase_storage_cli Stopped supabase local development setup. tags: - local-dev links: [] usage: supabase stop [flags] subcommands: [] flags: - id: no-backup name: --no-backup description: Deletes all data volumes after stopping. default_value: 'false' - id: project-id name: --project-id description: Local project ID to stop. default_value: '' - id: supabase-status title: supabase status summary: Show status of local Supabase containers description: |2 Shows status of the Supabase local development stack. Requires the local development stack to be started by running `supabase start` or `supabase db start`. You can export the connection parameters for [initializing supabase-js](https://supabase.com/docs/reference/javascript/initializing) locally by specifying the `-o env` flag. Supported parameters include `JWT_SECRET`, `ANON_KEY`, and `SERVICE_ROLE_KEY`. examples: - id: basic-usage name: Basic usage code: supabase status response: | supabase local development setup is running. API URL: http://127.0.0.1:54321 GraphQL URL: http://127.0.0.1:54321/graphql/v1 DB URL: postgresql://postgres:postgres@127.0.0.1:54322/postgres Studio URL: http://127.0.0.1:54323 Inbucket URL: http://127.0.0.1:54324 JWT secret: super-secret-jwt-token-with-at-least-32-characters-long anon key: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0 service_role key: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6InNlcnZpY2Vfcm9sZSIsImV4cCI6MTk4MzgxMjk5Nn0.EGIM96RAZx35lJzdJsyH-qQwv8Hdp7fsn3W0YpN81IU - id: output-env name: Format status as environment variables code: supabase status -o env response: | ANON_KEY="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0" API_URL="http://127.0.0.1:54321" DB_URL="postgresql://postgres:postgres@127.0.0.1:54322/postgres" GRAPHQL_URL="http://127.0.0.1:54321/graphql/v1" INBUCKET_URL="http://127.0.0.1:54324" JWT_SECRET="super-secret-jwt-token-with-at-least-32-characters-long" SERVICE_ROLE_KEY="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6InNlcnZpY2Vfcm9sZSIsImV4cCI6MTk4MzgxMjk5Nn0.EGIM96RAZx35lJzdJsyH-qQwv8Hdp7fsn3W0YpN81IU" STUDIO_URL="http://127.0.0.1:54323" - id: output-custom-name name: Customize the names of exported variables code: supabase status -o env --override-name auth.anon_key=SUPABASE_ANON_KEY --override-name auth.service_role_key=SUPABASE_SERVICE_KEY response: | Stopped services: [supabase_inbucket_cli supabase_rest_cli supabase_studio_cli] SUPABASE_ANON_KEY="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0" DB_URL="postgresql://postgres:postgres@127.0.0.1:54322/postgres" GRAPHQL_URL="http://127.0.0.1:54321/graphql/v1" JWT_SECRET="super-secret-jwt-token-with-at-least-32-characters-long" SUPABASE_SERVICE_KEY="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6InNlcnZpY2Vfcm9sZSIsImV4cCI6MTk4MzgxMjk5Nn0.EGIM96RAZx35lJzdJsyH-qQwv8Hdp7fsn3W0YpN81IU" tags: - local-dev links: [] usage: supabase status [flags] subcommands: [] flags: - id: output name: -o, --output <[ env | pretty | json | toml | yaml ]> description: Output format of status variables. default_value: pretty accepted_values: - id: env name: env type: '[ env | pretty | json | toml | yaml ]' - id: pretty name: pretty type: '[ env | pretty | json | toml | yaml ]' - id: json name: json type: '[ env | pretty | json | toml | yaml ]' - id: toml name: toml type: '[ env | pretty | json | toml | yaml ]' - id: yaml name: yaml type: '[ env | pretty | json | toml | yaml ]' - id: override-name name: --override-name description: Override specific variable names. default_value: '[]' - id: supabase-start title: supabase start summary: Start containers for Supabase local development description: |2 Starts the Supabase local development stack. Requires `supabase/config.toml` to be created in your current working directory by running `supabase init`. All service containers are started by default. You can exclude those not needed by passing in `-x` flag. To exclude multiple containers, either pass in a comma separated string, such as `-x gotrue,imgproxy`, or specify `-x` flag multiple times. > It is recommended to have at least 7GB of RAM to start all services. Health checks are automatically added to verify the started containers. Use `--ignore-health-check` flag to ignore these errors. examples: - id: basic-usage name: Basic usage code: supabase start response: | Creating custom roles supabase/roles.sql... Applying migration 20220810154536_employee.sql... Seeding data supabase/seed.sql... Started supabase local development setup. - id: without-studio name: Start containers without studio and imgproxy code: supabase start -x studio,imgproxy response: | Excluding container: supabase/studio:20221214-4eecc99 Excluding container: darthsim/imgproxy:v3.8.0 Started supabase local development setup. - id: ignore-health-check name: Ignore service health checks code: supabase start --ignore-health-check response: | service not healthy: [supabase_storage_cli] Started supabase local development setup. tags: - local-dev links: [] usage: supabase start [flags] subcommands: [] flags: - id: exclude name: -x, --exclude description: | Names of containers to not start. [gotrue,realtime,storage-api,imgproxy,kong,inbucket,postgrest,pgadmin-schema-diff,migra,postgres-meta,studio,edge-runtime,logflare,vector,pgbouncer] default_value: '[]' - id: ignore-health-check name: --ignore-health-check description: Ignore unhealthy services and exit 0 default_value: 'false' - id: supabase-sso title: supabase sso summary: Manage Single Sign-On (SSO) authentication for projects tags: - management-api links: [] subcommands: - supabase-sso-add - supabase-sso-info - supabase-sso-list - supabase-sso-remove - supabase-sso-show - supabase-sso-update flags: [] - id: supabase-sso-update title: supabase sso update summary: Update information about an SSO identity provider description: | Update the configuration settings of a already added SSO identity provider. examples: - id: basic-usage name: Replace domains code: |- supabase sso update 6df4d73f-bf21-405f-a084-b11adf19fea5 \ --project-ref abcdefghijklmnopqrst \ --domains new-company.com,new-company.net response: Information about the updated provider. - id: add-domains name: Add an additional domain code: |- supabase sso update 6df4d73f-bf21-405f-a084-b11adf19fea5 \ --project-ref abcdefghijklmnopqrst \ --add-domains company.net response: Information about the updated provider. - id: remove-domains name: Remove a domain code: |- supabase sso update 6df4d73f-bf21-405f-a084-b11adf19fea5 \ --project-ref abcdefghijklmnopqrst \ --remove-domains company.org response: Information about the updated provider. tags: [] links: [] usage: supabase sso update [flags] subcommands: [] flags: - id: add-domains name: --add-domains description: | Add this comma separated list of email domains to the identity provider. default_value: '[]' - id: attribute-mapping-file name: --attribute-mapping-file description: | File containing a JSON mapping between SAML attributes to custom JWT claims. default_value: '' - id: domains name: --domains description: | Replace domains with this comma separated list of email domains. default_value: '[]' - id: metadata-file name: --metadata-file description: | File containing a SAML 2.0 Metadata XML document describing the identity provider. default_value: '' - id: metadata-url name: --metadata-url description: | URL pointing to a SAML 2.0 Metadata XML document describing the identity provider. default_value: '' - id: remove-domains name: --remove-domains description: | Remove this comma separated list of email domains from the identity provider. default_value: '[]' - id: skip-url-validation name: --skip-url-validation description: | Whether local validation of the SAML 2.0 Metadata URL should not be performed. default_value: 'false' - id: output name: -o, --output <[ pretty | json | toml | yaml ]> description: Output format default_value: pretty accepted_values: - id: pretty name: pretty type: '[ pretty | json | toml | yaml ]' - id: json name: json type: '[ pretty | json | toml | yaml ]' - id: toml name: toml type: '[ pretty | json | toml | yaml ]' - id: yaml name: yaml type: '[ pretty | json | toml | yaml ]' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-sso-show title: supabase sso show summary: Show information about an SSO identity provider description: | Provides the information about an established connection to an identity provider. You can use --metadata to obtain the raw SAML 2.0 Metadata XML document stored in your project's configuration. examples: - id: basic-usage name: Show information code: |- supabase sso show 6df4d73f-bf21-405f-a084-b11adf19fea5 \ --project-ref abcdefghijklmnopqrst response: Information about the identity provider in pretty output. - id: metadata-output name: Get raw SAML 2.0 Metadata XML code: |- supabase sso show 6df4d73f-bf21-405f-a084-b11adf19fea5 \ --project-ref abcdefghijklmnopqrst \ --metadata response: |- Raw SAML 2.0 XML assigned to this identity provider. This is the version used in the authentication project, and if using a SAML 2.0 Metadata URL it may change depending on the caching information contained within the metadata. tags: [] links: [] usage: supabase sso show [flags] subcommands: [] flags: - id: metadata name: --metadata description: Show SAML 2.0 XML Metadata only default_value: 'false' - id: output name: -o, --output <[ pretty | json | toml | yaml ]> description: Output format default_value: pretty accepted_values: - id: pretty name: pretty type: '[ pretty | json | toml | yaml ]' - id: json name: json type: '[ pretty | json | toml | yaml ]' - id: toml name: toml type: '[ pretty | json | toml | yaml ]' - id: yaml name: yaml type: '[ pretty | json | toml | yaml ]' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-sso-remove title: supabase sso remove summary: Remove an existing SSO identity provider description: | Remove a connection to an already added SSO identity provider. Removing the provider will prevent existing users from logging in. Please treat this command with care. examples: - id: basic-usage name: Remove a provider code: |- supabase sso remove 6df4d73f-bf21-405f-a084-b11adf19fea5 \ --project-ref abcdefghijklmnopqrst response: |- Information about the removed identity provider. It's a good idea to save this in case you need it later on. tags: [] links: [] usage: supabase sso remove subcommands: [] flags: - id: output name: -o, --output <[ pretty | json | toml | yaml ]> description: Output format default_value: pretty accepted_values: - id: pretty name: pretty type: '[ pretty | json | toml | yaml ]' - id: json name: json type: '[ pretty | json | toml | yaml ]' - id: toml name: toml type: '[ pretty | json | toml | yaml ]' - id: yaml name: yaml type: '[ pretty | json | toml | yaml ]' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-sso-list title: supabase sso list summary: List all SSO identity providers for a project description: | List all connections to a SSO identity provider to your Supabase project. tags: [] links: [] usage: supabase sso list subcommands: [] flags: - id: output name: -o, --output <[ pretty | json | toml | yaml ]> description: Output format default_value: pretty accepted_values: - id: pretty name: pretty type: '[ pretty | json | toml | yaml ]' - id: json name: json type: '[ pretty | json | toml | yaml ]' - id: toml name: toml type: '[ pretty | json | toml | yaml ]' - id: yaml name: yaml type: '[ pretty | json | toml | yaml ]' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-sso-info title: supabase sso info summary: | Returns the SAML SSO settings required for the identity provider description: | Returns all of the important SSO information necessary for your project to be registered with a SAML 2.0 compatible identity provider. examples: - id: basic-usage name: Show project information code: supabase sso info --project-ref abcdefghijklmnopqrst response: Information about your project's SAML 2.0 configuration. tags: [] links: [] usage: supabase sso info subcommands: [] flags: - id: output name: -o, --output <[ pretty | json | toml | yaml ]> description: Output format default_value: pretty accepted_values: - id: pretty name: pretty type: '[ pretty | json | toml | yaml ]' - id: json name: json type: '[ pretty | json | toml | yaml ]' - id: toml name: toml type: '[ pretty | json | toml | yaml ]' - id: yaml name: yaml type: '[ pretty | json | toml | yaml ]' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-sso-add title: supabase sso add summary: Add a new SSO identity provider description: | Add and configure a new connection to a SSO identity provider to your Supabase project. examples: - id: basic-usage name: Add with Metadata URL code: |- supabase sso add \ --project-ref abcdefgijklmnopqrst \ --type saml \ --metadata-url 'https://...' \ --domains company.com response: |- Information about the added identity provider. You can use company.com as the domain name on the frontend side to initiate a SSO request to the identity provider. - id: with-xml name: Add with Metadata File code: |- supabase sso add \ --project-ref abcdefgijklmnopqrst \ --type saml \ --metadata-file /path/to/metadata/file.xml \ --domains company.com response: |- Information about the added identity provider. You can use company.com as the domain name on the frontend side to initiate a SSO request to the identity provider. tags: [] links: [] usage: supabase sso add [flags] subcommands: [] flags: - id: attribute-mapping-file name: --attribute-mapping-file description: | File containing a JSON mapping between SAML attributes to custom JWT claims. default_value: '' - id: domains name: --domains description: | Comma separated list of email domains to associate with the added identity provider. default_value: '[]' - id: metadata-file name: --metadata-file description: | File containing a SAML 2.0 Metadata XML document describing the identity provider. default_value: '' - id: metadata-url name: --metadata-url description: | URL pointing to a SAML 2.0 Metadata XML document describing the identity provider. default_value: '' - id: skip-url-validation name: --skip-url-validation description: | Whether local validation of the SAML 2.0 Metadata URL should not be performed. default_value: 'false' - id: type name: -t, --type <[ saml ]> description: Type of identity provider (according to supported protocol). required: true default_value: '' accepted_values: - id: saml name: saml type: '[ saml ]' - id: output name: -o, --output <[ pretty | json | toml | yaml ]> description: Output format default_value: pretty accepted_values: - id: pretty name: pretty type: '[ pretty | json | toml | yaml ]' - id: json name: json type: '[ pretty | json | toml | yaml ]' - id: toml name: toml type: '[ pretty | json | toml | yaml ]' - id: yaml name: yaml type: '[ pretty | json | toml | yaml ]' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-ssl-enforcement title: supabase ssl-enforcement summary: Manage SSL enforcement configuration tags: - management-api links: [] subcommands: - supabase-ssl-enforcement-get - supabase-ssl-enforcement-update flags: [] - id: supabase-ssl-enforcement-update title: supabase ssl-enforcement update summary: Update SSL enforcement configuration tags: [] links: [] usage: supabase ssl-enforcement update [flags] subcommands: [] flags: - id: disable-db-ssl-enforcement name: --disable-db-ssl-enforcement description: | Whether the DB should disable SSL enforcement for all external connections. default_value: 'false' - id: enable-db-ssl-enforcement name: --enable-db-ssl-enforcement description: | Whether the DB should enable SSL enforcement for all external connections. default_value: 'false' - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-ssl-enforcement-get title: supabase ssl-enforcement get summary: Get the current SSL enforcement configuration tags: [] links: [] usage: supabase ssl-enforcement get subcommands: [] flags: - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-snippets title: supabase snippets summary: Manage Supabase SQL snippets tags: - management-api links: [] subcommands: - supabase-snippets-download - supabase-snippets-list flags: [] - id: supabase-snippets-list title: supabase snippets list summary: List all SQL snippets description: List all SQL snippets of the linked project. tags: [] links: [] usage: supabase snippets list subcommands: [] flags: [] - id: supabase-snippets-download title: supabase snippets download summary: Download contents of a SQL snippet description: Download contents of the specified SQL snippet. tags: [] links: [] usage: supabase snippets download subcommands: [] flags: [] - id: supabase-services title: supabase services summary: Show versions of all Supabase services tags: - management-api links: [] usage: supabase services 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 ... subcommands: [] flags: - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - 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] ... subcommands: [] flags: - id: env-file name: --env-file description: Read secrets from a .env file. default_value: '' - id: project-ref name: --project-ref description: Project ref of the Supabase project. 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: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-projects title: supabase projects summary: Manage Supabase projects tags: - management-api links: [] subcommands: - supabase-projects-api-keys - supabase-projects-create - supabase-projects-delete - 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-delete title: supabase projects delete summary: Delete a Supabase project tags: [] links: [] usage: supabase projects delete subcommands: [] flags: [] - id: supabase-projects-create title: supabase projects create summary: Create a project on Supabase tags: [] links: [] usage: supabase projects create [flags] subcommands: [] flags: - id: db-password name: --db-password 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 description: Organization ID to create the project in. default_value: '' - id: plan name: --plan <[ free | pro ]> description: Select a plan that suits your needs. default_value: free accepted_values: - id: free name: free type: '[ free | pro ]' - id: pro name: pro type: '[ free | pro ]' - id: region name: --region description: Select a region close to you for the best performance. default_value: '' accepted_values: - id: ap-northeast-1 name: ap-northeast-1 type: string - id: ap-northeast-2 name: ap-northeast-2 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: ca-central-1 name: ca-central-1 type: string - id: eu-central-1 name: eu-central-1 type: string - id: eu-west-1 name: eu-west-1 type: string - id: eu-west-2 name: eu-west-2 type: string - id: eu-west-3 name: eu-west-3 type: string - id: sa-east-1 name: sa-east-1 type: string - id: us-east-1 name: us-east-1 type: string - id: us-west-1 name: us-west-1 type: string - id: us-west-2 name: us-west-2 type: string - id: supabase-projects-api-keys title: supabase projects api-keys summary: List all API keys for a Supabase project tags: [] links: [] usage: supabase projects api-keys [flags] subcommands: [] flags: - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-postgres-config title: supabase postgres-config summary: Manage Postgres database config tags: - management-api links: [] subcommands: - supabase-postgres-config-get - supabase-postgres-config-update flags: [] - id: supabase-postgres-config-update title: supabase postgres-config update summary: Update Postgres database config description: |- Overriding the default Postgres config could result in unstable database behavior. Custom configuration also overrides the optimizations generated based on the compute add-ons in use. tags: [] links: [] usage: supabase postgres-config update [flags] subcommands: [] flags: - id: config name: --config description: Config overrides specified as a 'key=value' pair default_value: '[]' - id: replace-existing-overrides name: --replace-existing-overrides description: | If true, replaces all existing overrides with the ones provided. If false (default), merges existing overrides with the ones provided. default_value: 'false' - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-postgres-config-get title: supabase postgres-config get summary: Get the current Postgres database config overrides tags: [] links: [] usage: supabase postgres-config get subcommands: [] flags: - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-orgs title: supabase orgs summary: Manage Supabase organizations tags: - management-api links: [] subcommands: - supabase-orgs-create - 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-orgs-create title: supabase orgs create summary: Create an organization description: Create an organization for the logged-in user. tags: [] links: [] usage: supabase orgs create subcommands: [] flags: [] - id: supabase-network-restrictions title: supabase network-restrictions summary: Manage network restrictions tags: - management-api links: [] subcommands: - supabase-network-restrictions-get - supabase-network-restrictions-update flags: [] - id: supabase-network-restrictions-update title: supabase network-restrictions update summary: Update network restrictions tags: [] links: [] usage: supabase network-restrictions update [flags] subcommands: [] flags: - id: bypass-cidr-checks name: --bypass-cidr-checks description: Bypass some of the CIDR validation checks. default_value: 'false' - id: db-allow-cidr name: --db-allow-cidr description: CIDR to allow DB connections from. default_value: '[]' - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-network-restrictions-get title: supabase network-restrictions get summary: Get the current network restrictions tags: [] links: [] usage: supabase network-restrictions get subcommands: [] flags: - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-network-bans title: supabase network-bans summary: Manage network bans description: |- Network bans are IPs that get temporarily blocked if their traffic pattern looks abusive (e.g. multiple failed auth attempts). The subcommands help you view the current bans, and unblock IPs if desired. tags: - management-api links: [] subcommands: - supabase-network-bans-get - supabase-network-bans-remove flags: [] - id: supabase-network-bans-remove title: supabase network-bans remove summary: Remove a network ban tags: [] links: [] usage: supabase network-bans remove [flags] subcommands: [] flags: - id: db-unban-ip name: --db-unban-ip description: IP to allow DB connections from. default_value: '[]' - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-network-bans-get title: supabase network-bans get summary: Get the current network bans tags: [] links: [] usage: supabase network-bans get subcommands: [] flags: - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-migration title: supabase migration summary: Manage database migration scripts tags: - local-dev links: [] subcommands: - supabase-migration-list - supabase-migration-new - supabase-migration-repair - supabase-migration-squash - supabase-migration-up flags: [] - id: supabase-migration-up title: supabase migration up summary: Apply pending migrations to local database tags: [] links: [] usage: supabase migration up [flags] subcommands: [] flags: - id: db-url name: --db-url description: | Applies migrations to the database specified by the connection string (must be percent-encoded). default_value: '' - id: include-all name: --include-all description: Include all migrations not found on remote history table. default_value: 'false' - id: linked name: --linked description: Applies pending migrations to the linked project. default_value: 'false' - id: local name: --local description: Applies pending migrations to the local database. default_value: 'true' - id: supabase-migration-squash title: supabase migration squash summary: Squash migrations to a single file tags: [] links: [] usage: supabase migration squash [flags] subcommands: [] flags: - id: db-url name: --db-url description: | Squashes migrations of the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Squashes the migration history of the linked project. default_value: 'false' - id: local name: --local description: Squashes the migration history of the local database. default_value: 'true' - id: password name: -p, --password description: Password to your remote Postgres database. default_value: '' - id: version name: --version description: Squash up to the specified version. default_value: '' - id: supabase-migration-repair title: supabase migration repair summary: Repair the migration history table description: |2 Repairs the remote migration history table. Requires your local project to be linked to a remote database by running `supabase link`. If your local and remote migration history goes out of sync, you can repair the remote history by marking specific migrations as `--status applied` or `--status reverted`. Marking as `reverted` will delete an existing record from the migration history table while marking as `applied` will insert a new record. For example, your migration history table may look like this after running `db remote commit` for the first time. ```bash $ supabase migration list LOCAL │ REMOTE │ TIME (UTC) ─────────────────┼────────────────┼────────────────────── 20230103054303 │ 20230103054303 │ 2023-01-03 05:43:03 ``` To reset your migration history to a clean state, first delete your local migration file. ```bash $ rm supabase/migrations/20230103054303_remote_commit.sql $ supabase migration list LOCAL │ REMOTE │ TIME (UTC) ─────────────────┼────────────────┼────────────────────── │ 20230103054303 │ 2023-01-03 05:43:03 ``` Then mark the remote migration `20230103054303` as reverted. ```bash $ supabase migration repair 20230103054303 --status reverted Repaired migration history: 20230103054303 => reverted $ supabase migration list LOCAL │ REMOTE │ TIME (UTC) ─────────────────┼────────────────┼────────────────────── ``` Now you can run `db remote commit` again to dump the remote schema as a local migration file. examples: - id: basic-usage name: Mark a migration as reverted code: supabase migration repair 20230103054303 --status reverted response: | Repaired migration history: 20230103054303 => reverted - id: mark-applied name: Mark a migration as applied code: supabase migration repair 20230222032233 --status applied response: | Repaired migration history: 20230222032233 => applied tags: [] links: [] usage: supabase migration repair [flags] subcommands: [] flags: - id: db-url name: --db-url description: | Repairs migrations of the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Repairs the migration history of the linked project. default_value: 'true' - id: local name: --local description: Repairs the migration history of the local database. default_value: 'false' - id: password name: -p, --password description: Password to your remote Postgres database. default_value: '' - id: status name: --status <[ applied | reverted ]> description: Version status to update. required: true default_value: '' accepted_values: - id: applied name: applied type: '[ applied | reverted ]' - id: reverted name: reverted type: '[ applied | reverted ]' - id: supabase-migration-new title: supabase migration new summary: Create an empty migration script description: |2 Creates a new migration file locally. A `supabase/migrations` directory will be created if it does not already exists in your current `workdir`. All schema migration files must be created in this directory following the pattern `_.sql`. Outputs from other commands like `db diff` may be piped to `migration new ` via stdin. examples: - id: basic-usage name: Basic usage code: supabase migration new schema_test response: | Created new migration at supabase/migrations/20230306095710_schema_test.sql. - id: pipe-stdin name: With statements piped from stdin code: echo "create schema if not exists test;" | supabase migration new schema_test response: | Created new migration at supabase/migrations/20230306095710_schema_test.sql. tags: [] links: [] usage: supabase migration new subcommands: [] flags: [] - id: supabase-migration-list title: supabase migration list summary: List local and remote migrations description: |2 Lists migration history in both local and remote databases. Requires your local project to be linked to a remote database by running `supabase link`. For self-hosted databases, you can pass in the connection parameters using `--db-url` flag. > Note that URL strings must be escaped according to [RFC 3986](https://www.rfc-editor.org/rfc/rfc3986). Local migrations are stored in `supabase/migrations` directory while remote migrations are tracked in `supabase_migrations.schema_migrations` table. Only the timestamps are compared to identify any differences. In case of discrepancies between the local and remote migration history, you can resolve them using the `migration repair` command. examples: - id: basic-usage name: Basic usage code: supabase migration list response: |2 LOCAL │ REMOTE │ TIME (UTC) ─────────────────┼────────────────┼────────────────────── │ 20230103054303 │ 2023-01-03 05:43:03 │ 20230103093141 │ 2023-01-03 09:31:41 20230222032233 │ │ 2023-02-22 03:22:33 - id: with-db-url name: Connect to self-hosted database code: supabase migration list --db-url 'postgres://postgres[:percent_encoded_password]@127.0.0.1[:port]/postgres' response: |2 LOCAL │ REMOTE │ TIME (UTC) ─────────────────┼────────────────┼────────────────────── 20230103054303 │ 20230103054303 │ 2023-01-03 05:43:03 20230103093141 │ 20230103093141 │ 2023-01-03 09:31:41 tags: [] links: [] usage: supabase migration list [flags] subcommands: [] flags: - id: db-url name: --db-url description: | Lists migrations of the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Lists migrations applied to the linked project. default_value: 'true' - id: local name: --local description: Lists migrations applied to the local database. default_value: 'false' - id: password name: -p, --password description: Password to your remote Postgres database. default_value: '' - id: supabase-logout title: supabase logout summary: Log out and delete access tokens locally tags: - local-dev links: [] usage: supabase logout subcommands: [] flags: [] - id: supabase-login title: supabase login summary: Authenticate using an access token description: |2 Connect the Supabase CLI to your Supabase account by logging in with your [personal access token](https://supabase.com/dashboard/account/tokens). Your access token is stored securely in [native credentials storage](https://github.com/zalando/go-keyring#dependencies). If native credentials storage is unavailable, it will be written to a plain text file at `~/.supabase/access-token`. > If this behavior is not desired, such as in a CI environment, you may skip login by specifying the `SUPABASE_ACCESS_TOKEN` environment variable in other commands. The Supabase CLI uses the stored token to access Management APIs for projects, functions, secrets, etc. examples: - id: basic-usage name: Basic usage code: supabase login response: | You can generate an access token from https://supabase.com/dashboard/account/tokens Enter your access token: sbp_**************************************** Finished supabase login. tags: - local-dev links: [] usage: supabase login [flags] subcommands: [] flags: - id: name name: --name description: | Name that will be used to store token in your settings, defaults to built-in token name generator default_value: '' - id: no-browser name: --no-browser description: Do not open browser automatically default_value: 'false' - id: token name: --token description: Use provided token instead of automatic login flow default_value: '' - id: supabase-link title: supabase link summary: Link to a Supabase project description: |2 Link your local development project to a hosted Supabase project. PostgREST configurations are fetched from the Supabase platform and validated against your local configuration file. Optionally, database settings can be validated if you provide a password. Your database password is saved in native credentials storage if available. > If you do not want to be prompted for the database password, such as in a CI environment, you may specify it explicitly via the `SUPABASE_DB_PASSWORD` environment variable. Some commands like `db dump`, `db push`, and `db remote commit` require your project to be linked first. examples: - id: basic-usage name: Basic usage code: supabase link --project-ref ******************** response: | Enter your database password (or leave blank to skip): ******** Finished supabase link. - id: without-password name: Link without database password code: supabase link --project-ref ******************** <<< "" response: | Enter your database password (or leave blank to skip): Finished supabase link. - id: using-alternate-dns name: Link using DNS-over-HTTPS resolver code: supabase link --project-ref ******************** --dns-resolver https response: | Enter your database password (or leave blank to skip): Finished supabase link. tags: - local-dev links: [] usage: supabase link [flags] subcommands: [] flags: - id: password name: -p, --password description: Password to your remote Postgres database. default_value: '' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-inspect title: supabase inspect summary: Tools to inspect your Supabase project tags: - local-dev links: [] subcommands: - supabase-inspect-db flags: [] - id: supabase-inspect-db title: supabase inspect db summary: Tools to inspect your Supabase database tags: [] links: [] subcommands: - supabase-inspect-db-bloat - supabase-inspect-db-blocking - supabase-inspect-db-cache-hit - supabase-inspect-db-calls - supabase-inspect-db-index-sizes - supabase-inspect-db-index-usage - supabase-inspect-db-locks - supabase-inspect-db-long-running-queries - supabase-inspect-db-outliers - supabase-inspect-db-replication-slots - supabase-inspect-db-role-connections - supabase-inspect-db-seq-scans - supabase-inspect-db-table-index-sizes - supabase-inspect-db-table-record-counts - supabase-inspect-db-table-sizes - supabase-inspect-db-total-index-size - supabase-inspect-db-total-table-sizes - supabase-inspect-db-unused-indexes - supabase-inspect-db-vacuum-stats flags: [] - id: supabase-inspect-db-vacuum-stats title: supabase inspect db vacuum-stats summary: Show statistics related to vacuum operations per table description: |2 This shows you stats about the vacuum activities for each table. Due to Postgres' [MVCC](https://www.postgresql.org/docs/current/mvcc.html) when data is updated or deleted new rows are created and old rows are made invisible and marked as "dead tuples". Usually the [autovaccum](https://supabase.com/docs/guides/platform/database-size#vacuum-operations) process will aysnchronously clean the dead tuples. The command lists when the last vacuum and last auto vacuum took place, the row count on the table as well as the count of dead rows and whether autovacuum is expected to run or not. If the number of dead rows is much higher than the row count, or if an autovacuum is expected but has not been performed for some time, this can indicate that autovacuum is not able to keep up and that your vacuum settings need to be tweaked or that you require more compute or disk IOPS to allow autovaccum to complete. ``` SCHEMA │ TABLE │ LAST VACUUM │ LAST AUTO VACUUM │ ROW COUNT │ DEAD ROW COUNT │ EXPECT AUTOVACUUM? ──────────────────────┼──────────────────────────────────┼─────────────┼──────────────────┼──────────────────────┼────────────────┼───────────────────── auth │ users │ │ 2023-06-26 12:34 │ 18,030 │ 0 │ no public │ profiles │ │ 2023-06-26 23:45 │ 13,420 │ 28 │ no public │ logs │ │ 2023-06-26 01:23 │ 1,313,033 │ 3,318,228 │ yes storage │ objects │ │ │ No stats │ 0 │ no storage │ buckets │ │ │ No stats │ 0 │ no supabase_migrations │ schema_migrations │ │ │ No stats │ 0 │ no ``` tags: [] links: [] usage: supabase inspect db vacuum-stats subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-unused-indexes title: supabase inspect db unused-indexes summary: Show indexes with low usage description: |2 This command displays indexes that have < 50 scans recorded against them, and are greater than 5 pages in size, ordered by size relative to the number of index scans. This command is generally useful for discovering indexes that are unused. Indexes can impact write performance, as well as read performance should they occupy space in memory, its a good idea to remove indexes that are not needed or being used. ``` TABLE │ INDEX │ INDEX SIZE │ INDEX SCANS ─────────────────────┼────────────────────────────────────────────┼────────────┼────────────── public.users │ user_id_created_at_idx │ 97 MB │ 0 ``` tags: [] links: [] usage: supabase inspect db unused-indexes subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-total-table-sizes title: supabase inspect db total-table-sizes summary: Show total table sizes, including table index sizes description: |2- This command displays the total size of each table in the database. It is the sum of the values that `pg_table_size()` and `pg_indexes_size()` gives for each table. System tables inside `pg_catalog` and `information_schema` are not included. ``` NAME │ SIZE ───────────────────────────────────┼───────────── job_run_details │ 395 MB slack_msgs │ 648 kB emails │ 640 kB ``` tags: [] links: [] usage: supabase inspect db total-table-sizes subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-total-index-size title: supabase inspect db total-index-size summary: Show total size of all indexes description: |2- This command displays the total size of all indexes on the database. It is calculated by taking the number of pages (reported in `relpages`) and multiplying it by the page size (8192 bytes). ``` SIZE ───────── 12 MB ``` tags: [] links: [] usage: supabase inspect db total-index-size subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-table-sizes title: supabase inspect db table-sizes summary: | Show table sizes of individual tables without their index sizes description: |2- This command displays the size of each table in the database. It is calculated by using the system administration function `pg_table_size()`, which includes the size of the main data fork, free space map, visibility map and TOAST data. It does not include the size of the table's indexes. ``` NAME │ SIZE ───────────────────────────────────┼───────────── job_run_details │ 385 MB emails │ 584 kB job │ 40 kB sessions │ 0 bytes prod_resource_notifications_meta │ 0 bytes ``` tags: [] links: [] usage: supabase inspect db table-sizes subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-table-record-counts title: supabase inspect db table-record-counts summary: Show estimated number of rows per table description: |2- This command displays an estimated count of rows per table, descending by estimated count. The estimated count is derived from `n_live_tup`, which is updated by vacuum operations. Due to the way `n_live_tup` is populated, sparse vs. dense pages can result in estimations that are significantly out from the real count of rows. ``` NAME │ ESTIMATED COUNT ─────────────┼────────────────── logs │ 322943 emails │ 1103 job │ 1 migrations │ 0 ``` tags: [] links: [] usage: supabase inspect db table-record-counts subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-table-index-sizes title: supabase inspect db table-index-sizes summary: Show index sizes of individual tables description: |2 This command displays the total size of indexes for each table. It is calculated by using the system administration function `pg_indexes_size()`. ``` TABLE │ INDEX SIZE ───────────────────────────────────┼───────────── job_run_details │ 10104 kB users │ 128 kB job │ 32 kB instances │ 8192 bytes http_request_queue │ 0 bytes ``` tags: [] links: [] usage: supabase inspect db table-index-sizes subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-seq-scans title: supabase inspect db seq-scans summary: Show number of sequential scans recorded against all tables description: |2+ This command displays the number of sequential scans recorded against all tables, descending by count of sequential scans. Tables that have very high numbers of sequential scans may be underindexed, and it may be worth investigating queries that read from these tables. ``` NAME │ COUNT ───────────────────────────────────┼───────── emails │ 182435 users │ 25063 job_run_details │ 60 schema_migrations │ 0 migrations │ 0 ``` tags: [] links: [] usage: supabase inspect db seq-scans subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-role-connections title: supabase inspect db role-connections summary: Show number of active connections for all database roles description: |2 This command shows the number of active connections for each database roles to see which specific role might be consuming more connections than expected. This is a Supabase specific command. You can see this breakdown on the dashboard as well: https://app.supabase.com/project/_/database/roles The maximum number of active connections depends [on your instance size](https://supabase.com/docs/guides/platform/compute-add-ons). You can [manually overwrite](https://supabase.com/docs/guides/platform/performance#allowing-higher-number-of-connections) the allowed number of connection but it is not advised. ``` ROLE NAME │ ACTIVE CONNCTION ────────────────────────────┼─────────────────── authenticator │ 5 postgres │ 5 supabase_admin │ 1 pgbouncer │ 1 anon │ 0 authenticated │ 0 service_role │ 0 dashboard_user │ 0 supabase_auth_admin │ 0 supabase_storage_admin │ 0 supabase_functions_admin │ 0 pgsodium_keyholder │ 0 pg_read_all_data │ 0 pg_write_all_data │ 0 pg_monitor │ 0 Active connections 12/90 ``` tags: [] links: [] usage: supabase inspect db role-connections subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-replication-slots title: supabase inspect db replication-slots summary: Show information about replication slots on the database description: |2- This command shows information about [logical replication slots](https://www.postgresql.org/docs/current/logical-replication.html) that are setup on the database. It shows if the slot is active, the state of the WAL sender process ('startup', 'catchup', 'streaming', 'backup', 'stopping') the replication client address and the replication lag in GB. This command is useful to check that the amount of replication lag is as low as possible, replication lag can occur due to network latency issues, slow disk I/O, long running transactions or lack of ability for the subscriber to consume WAL fast enough. ``` NAME │ ACTIVE │ STATE │ REPLICATION CLIENT ADDRESS │ REPLICATION LAG GB ─────────────────────────────────────────────┼────────┼─────────┼────────────────────────────┼───────────────────── supabase_realtime_replication_slot │ t │ N/A │ N/A │ 0 datastream │ t │ catchup │ 24.201.24.106 │ 45 ``` tags: [] links: [] usage: supabase inspect db replication-slots subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-outliers title: supabase inspect db outliers summary: | Show queries from pg_stat_statements ordered by total execution time description: |2 This command displays statements, obtained from `pg_stat_statements`, ordered by the amount of time to execute in aggregate. This includes the statement itself, the total execution time for that statement, the proportion of total execution time for all statements that statement has taken up, the number of times that statement has been called, and the amount of time that statement spent on synchronous I/O (reading/writing from the file system). Typically, an efficient query will have an appropriate ratio of calls to total execution time, with as little time spent on I/O as possible. Queries that have a high total execution time but low call count should be investigated to improve their performance. Queries that have a high proportion of execution time being spent on synchronous I/O should also be investigated. ``` QUERY │ EXECUTION TIME │ PROPORTION OF EXEC TIME │ NUMBER CALLS │ SYNC IO TIME ─────────────────────────────────────────┼──────────────────┼─────────────────────────┼──────────────┼─────────────── SELECT * FROM archivable_usage_events.. │ 154:39:26.431466 │ 72.2% │ 34,211,877 │ 00:00:00 COPY public.archivable_usage_events (.. │ 50:38:33.198418 │ 23.6% │ 13 │ 13:34:21.00108 COPY public.usage_events (id, reporte.. │ 02:32:16.335233 │ 1.2% │ 13 │ 00:34:19.784318 INSERT INTO usage_events (id, retaine.. │ 01:42:59.436532 │ 0.8% │ 12,328,187 │ 00:00:00 SELECT * FROM usage_events WHERE (alp.. │ 01:18:10.754354 │ 0.6% │ 102,114,301 │ 00:00:00 ``` tags: [] links: [] usage: supabase inspect db outliers subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-long-running-queries title: supabase inspect db long-running-queries summary: | Show currently running queries running for longer than 5 minutes description: |2 This command displays currently running queries, that have been running for longer than 5 minutes, descending by duration. Very long running queries can be a source of multiple issues, such as preventing DDL statements completing or vacuum being unable to update `relfrozenxid`. ``` PID │ DURATION │ QUERY ───────┼─────────────────┼─────────────────────────────────────────────────────────────────────────────────────── 19578 | 02:29:11.200129 | EXPLAIN SELECT "students".* FROM "students" WHERE "students"."id" = 1450645 LIMIT 1 19465 | 02:26:05.542653 | EXPLAIN SELECT "students".* FROM "students" WHERE "students"."id" = 1889881 LIMIT 1 19632 | 02:24:46.962818 | EXPLAIN SELECT "students".* FROM "students" WHERE "students"."id" = 1581884 LIMIT 1 ``` tags: [] links: [] usage: supabase inspect db long-running-queries subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-locks title: supabase inspect db locks summary: | Show queries which have taken out an exclusive lock on a relation description: |2 This command displays queries that have taken out an exclusive lock on a relation. Exclusive locks typically prevent other operations on that relation from taking place, and can be a cause of "hung" queries that are waiting for a lock to be granted. If you see a query that is hanging for a very long time or causing blocking issues you may consider killing the query by connecting to the database and running `SELECT pg_cancel_backend(PID);` to cancel the query. If the query still does not stop you can force a hard stop by running `SELECT pg_terminate_backend(PID);` ``` PID │ RELNAME │ TRANSACTION ID │ GRANTED │ QUERY │ AGE ─────────┼─────────┼────────────────┼─────────┼─────────────────────────────────────────┼─────────── 328112 │ null │ 0 │ t │ SELECT * FROM logs; │ 00:04:20 ``` tags: [] links: [] usage: supabase inspect db locks subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-index-usage title: supabase inspect db index-usage summary: Show information about the efficiency of indexes description: "\n\nThis command provides information on the efficiency of indexes, represented as what percentage of total scans were index scans. A low percentage can indicate under indexing, or wrong data being indexed.\n\n```\n TABLE NAME │ PERCENTAGE OF TIMES INDEX USED │ ROWS IN TABLE\n ────────────────────┼────────────────────────────────┼────────────────\n user_events │ 99 │ 4225318 \n user_feed │ 99 │ 3581573\n unindexed_table │ 0 │ 322911\n job │ 100 │ 33242\n schema_migrations │ 97 │ 0\n migrations │ Insufficient data │ 0\n```" tags: [] links: [] usage: supabase inspect db index-usage subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-index-sizes title: supabase inspect db index-sizes summary: Show index sizes of individual indexes description: |2- This command displays the size of each each index in the database. It is calculated by taking the number of pages (reported in `relpages`) and multiplying it by the page size (8192 bytes). ``` NAME │ SIZE ──────────────────────────────┼───────────── user_events_index │ 2082 MB job_run_details_pkey │ 3856 kB schema_migrations_pkey │ 16 kB refresh_tokens_token_unique │ 8192 bytes users_instance_id_idx │ 0 bytes buckets_pkey │ 0 bytes ``` tags: [] links: [] usage: supabase inspect db index-sizes subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-calls title: supabase inspect db calls summary: | Show queries from pg_stat_statements ordered by total times called description: |2 This command is much like the `supabase inspect db outliers` command, but ordered by the number of times a statement has been called. You can use this information to see which queries are called most often, which can potentially be good candidates for optimisation. ``` QUERY │ TOTAL EXECUTION TIME │ PROPORTION OF TOTAL EXEC TIME │ NUMBER CALLS │ SYNC IO TIME ─────────────────────────────────────────────────┼──────────────────────┼───────────────────────────────┼──────────────┼────────────────── SELECT * FROM users WHERE id = $1 │ 14:50:11.828939 │ 89.8% │ 183,389,757 │ 00:00:00.002018 SELECT * FROM user_events │ 01:20:23.466633 │ 1.4% │ 78,325 │ 00:00:00 INSERT INTO users (email, name) VALUES ($1, $2)│ 00:40:11.616882 │ 0.8% │ 54,003 │ 00:00:00.000322 ``` tags: [] links: [] usage: supabase inspect db calls subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-cache-hit title: supabase inspect db cache-hit summary: Show cache hit rates for tables and indices description: |2- This command provides information on the efficiency of the buffer cache and how often your queries have to go hit the disk rather than reading from memory. Information on both index reads (`index hit rate`) as well as table reads (`table hit rate`) are shown. In general, databases with low cache hit rates perform worse as it is slower to go to disk than retrieve data from memory. If your table hit rate is low, this can indicate that you do not have enough RAM and you may benefit from upgrading to a larger compute addon with more memory. If your index hit rate is low, this may indicate that there is scope to add more appropriate indexes. The hit rates are calculated as a ratio of number of table or index blocks fetched from the postgres buffer cache against the sum of cached blocks and uncached blocks read from disk. On smaller compute plans (free, small, medium), a ratio of below 99% can indicate a problem. On larger plans the hit rates may be lower but performance will remain constant as the data may use the OS cache rather than Postgres buffer cache. ``` NAME │ RATIO ─────────────────┼─────────── index hit rate │ 0.996621 table hit rate │ 0.999341 ``` tags: [] links: [] usage: supabase inspect db cache-hit subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-blocking title: supabase inspect db blocking summary: | Show queries that are holding locks and the queries that are waiting for them to be released description: |2 This command shows you statements that are currently holding locks and blocking, as well as the statement that is being blocked. This can be used in conjunction with `inspect db locks` to determine which statements need to be terminated in order to resolve lock contention. ``` BLOCKED PID │ BLOCKING STATEMENT │ BLOCKING DURATION │ BLOCKING PID │ BLOCKED STATEMENT │ BLOCKED DURATION ──────────────┼──────────────────────────────┼───────────────────┼──────────────┼────────────────────────────────────────────────────────────────────────────────────────┼─────────────────── 253 │ select count(*) from mytable │ 00:00:03.838314 │ 13495 │ UPDATE "mytable" SET "updated_at" = '2023─08─03 14:07:04.746688' WHERE "id" = 83719341 │ 00:00:03.821826 ``` tags: [] links: [] usage: supabase inspect db blocking subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-inspect-db-bloat title: supabase inspect db bloat summary: | Estimates space allocated to a relation that is full of dead tuples description: |2 This command displays an estimation of table "bloat" - Due to Postgres' [MVCC](https://www.postgresql.org/docs/current/mvcc.html) when data is updated or deleted new rows are created and old rows are made invisible and marked as "dead tuples". Usually the [autovaccum](https://supabase.com/docs/guides/platform/database-size#vacuum-operations) process will asynchronously clean the dead tuples. Sometimes the autovaccum is unable to work fast enough to reduce or prevent tables from becoming bloated. High bloat can slow down queries, cause excessive IOPS and waste space in your database. Tables with a high bloat ratio should be investigated to see if there are vacuuming is not quick enough or there are other issues. ``` TYPE │ SCHEMA NAME │ OBJECT NAME │ BLOAT │ WASTE ────────┼─────────────┼────────────────────────────┼───────┼───────────── table │ public │ very_bloated_table │ 41.0 │ 700 MB table │ public │ my_table │ 4.0 │ 76 MB table │ public │ happy_table │ 1.0 │ 1472 kB index │ public │ happy_table::my_nice_index │ 0.7 │ 880 kB ``` tags: [] links: [] usage: supabase inspect db bloat subcommands: [] flags: - id: db-url name: --db-url description: | Inspect the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Inspect the linked project. default_value: 'true' - id: local name: --local description: Inspect the local database. default_value: 'false' - id: supabase-init title: supabase init summary: Initialize a local project description: |2 Initialize configurations for Supabase local development. A `supabase/config.toml` file is created in your current working directory. This configuration is specific to each local project. > You may override the directory path by specifying the `SUPABASE_WORKDIR` environment variable or `--workdir` flag. In addition to `config.toml`, the `supabase` directory may also contain other Supabase objects, such as `migrations`, `functions`, `tests`, etc. examples: - id: basic-usage name: Basic usage code: supabase init response: Finished supabase init. - id: from-workdir name: Initialize from an existing directory code: supabase init --workdir . response: Finished supabase init. tags: - local-dev links: [] usage: supabase init [flags] subcommands: [] flags: - id: use-orioledb name: --use-orioledb description: Use OrioleDB storage engine for Postgres default_value: 'false' - id: with-vscode-workspace name: --with-vscode-workspace description: Generate VS Code workspace. default_value: 'false' - id: supabase-gen title: supabase gen summary: Run code generation tools tags: - local-dev links: [] subcommands: - supabase-gen-keys - 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 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 description: Generate types from a project ID. default_value: '' - id: schema name: --schema description: Schemas to generate types for. default_value: '[]' - id: supabase-gen-keys title: supabase gen keys summary: Generate keys for preview branch tags: [] links: [] usage: supabase gen keys [flags] subcommands: [] flags: - id: output name: -o, --output <[ env | json | toml | yaml ]> description: Output format of key variables. default_value: env accepted_values: - id: env name: env type: '[ env | json | toml | yaml ]' - id: json name: json type: '[ env | json | toml | yaml ]' - id: toml name: toml type: '[ env | json | toml | yaml ]' - id: yaml name: yaml type: '[ env | json | toml | yaml ]' - id: override-name name: --override-name description: Override specific variable names. default_value: '[]' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: supabase-functions title: supabase functions summary: Manage Supabase Edge functions tags: - management-api links: [] subcommands: - supabase-functions-delete - supabase-functions-deploy - supabase-functions-download - supabase-functions-list - supabase-functions-new - supabase-functions-serve flags: [] - id: supabase-functions-serve title: supabase functions serve summary: Serve all Functions locally tags: [] links: [] usage: supabase functions serve [flags] subcommands: [] flags: - id: env-file name: --env-file description: | Path to an env file to be populated to the Function environment. default_value: '' - id: import-map name: --import-map description: Path to import map file. 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 subcommands: [] flags: [] - id: supabase-functions-list title: supabase functions list summary: List all Functions in Supabase description: List all Functions in the linked Supabase project. tags: [] links: [] usage: supabase functions list [flags] subcommands: [] flags: - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-functions-download title: supabase functions download summary: Download a Function from Supabase description: | Download the source code for a Function from the linked Supabase project. tags: [] links: [] usage: supabase functions download [flags] subcommands: [] flags: - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - 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: import-map name: --import-map description: Path to import map file. default_value: '' - id: no-verify-jwt name: --no-verify-jwt description: Disable JWT verification for the Function. default_value: 'false' - id: project-ref name: --project-ref 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 [flags] subcommands: [] flags: - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-encryption title: supabase encryption summary: Manage encryption keys of Supabase projects tags: - management-api links: [] subcommands: - supabase-encryption-get-root-key - supabase-encryption-update-root-key flags: [] - id: supabase-encryption-update-root-key title: supabase encryption update-root-key summary: Update root encryption key of a Supabase project tags: [] links: [] usage: supabase encryption update-root-key subcommands: [] flags: - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-encryption-get-root-key title: supabase encryption get-root-key summary: Get the root encryption key of a Supabase project tags: [] links: [] usage: supabase encryption get-root-key subcommands: [] flags: - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-domains title: supabase domains summary: Manage custom domain names for Supabase projects description: | Manage custom domain names for Supabase projects. Use of custom domains and vanity subdomains is mutually exclusive. tags: - management-api links: [] subcommands: - supabase-domains-activate - supabase-domains-create - supabase-domains-delete - supabase-domains-get - supabase-domains-reverify flags: [] - 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: include-raw-output name: --include-raw-output description: Include raw output (useful for debugging). default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - 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: include-raw-output name: --include-raw-output description: Include raw output (useful for debugging). default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - 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: include-raw-output name: --include-raw-output description: Include raw output (useful for debugging). default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - 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 description: The custom hostname to use for your Supabase project. default_value: '' - id: include-raw-output name: --include-raw-output description: Include raw output (useful for debugging). default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the 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: include-raw-output name: --include-raw-output description: Include raw output (useful for debugging). default_value: 'false' - id: project-ref name: --project-ref description: Project ref of the Supabase project. default_value: '' - id: supabase-db title: supabase db summary: Manage Postgres databases tags: - local-dev links: [] subcommands: - supabase-db-diff - supabase-db-dump - supabase-db-lint - supabase-db-pull - supabase-db-push - supabase-db-reset - supabase-db-start flags: [] - id: supabase-db-start title: supabase db start summary: Starts local Postgres database tags: [] links: [] usage: supabase db start subcommands: [] flags: [] - id: supabase-db-reset title: supabase db reset summary: Resets the local database to current migrations description: |2 Resets the local database to a clean state. Requires the local development stack to be started by running `supabase start`. Recreates the local Postgres container and applies all local migrations found in `supabase/migrations` directory. If test data is defined in `supabase/seed.sql`, it will be seeded after the migrations are run. Any other data or schema changes made during local development will be discarded. Note that since Postgres roles are cluster level entities, those changes will persist between resets. In order to reset custom roles, you need to restart the local development stack. examples: - id: basic-usage name: Basic usage code: supabase db reset response: | Resetting database... Initializing schema... Applying migration 20220810154537_create_employees_table.sql... Seeding data supabase/seed.sql... Finished supabase db reset on branch main. tags: [] links: [] usage: supabase db reset [flags] subcommands: [] flags: - id: db-url name: --db-url description: | Resets the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Resets the linked project with local migrations. default_value: 'false' - id: local name: --local description: Resets the local database with local migrations. default_value: 'true' - id: version name: --version description: Reset up to the specified version. default_value: '' - id: supabase-db-push title: supabase db push summary: Push new migrations to the remote database description: |2 Pushes all local migrations to a remote database. Requires your local project to be linked to a remote database by running `supabase link`. For self-hosted databases, you can pass in the connection parameters using `--db-url` flag. The first time this command is run, a migration history table will be created under `supabase_migrations.schema_migrations`. After successfully applying a migration, a new row will be inserted into the migration history table with timestamp as its unique id. Subsequent pushes will skip migrations that have already been applied. If you need to mutate the migration history table, such as deleting existing entries or inserting new entries without actually running the migration, use the `migration repair` command. Use the `--dry-run` flag to view the list of changes before applying. examples: - id: basic-usage name: Basic usage code: supabase db push response: | Linked project is up to date. - id: self-hosted name: Self hosted code: supabase db push --db-url "postgres://user:pass@127.0.0.1:5432/postgres" response: | Pushing migration 20230410135622_create_employees_table.sql... Finished supabase db push. - id: dry-run name: Dry run code: supabase db push --dry-run response: | DRY RUN: migrations will *not* be pushed to the database. Would push migration 20230410135622_create_employees_table.sql... Would push migration 20230425064254_my_table.sql... Finished supabase db push. tags: [] links: [] usage: supabase db push [flags] subcommands: [] flags: - id: db-url name: --db-url description: | Pushes to the database specified by the connection string (must be percent-encoded). default_value: '' - id: dry-run name: --dry-run description: | Print the migrations that would be applied, but don't actually apply them. default_value: 'false' - id: include-all name: --include-all description: Include all migrations not found on remote history table. default_value: 'false' - id: include-roles name: --include-roles description: Include custom roles from supabase/roles.sql. default_value: 'false' - id: include-seed name: --include-seed description: Include seed data from supabase/seed.sql. default_value: 'false' - id: linked name: --linked description: Pushes to the linked project. default_value: 'true' - id: local name: --local description: Pushes to the local database. default_value: 'false' - id: password name: -p, --password description: Password to your remote Postgres database. default_value: '' - id: supabase-db-pull title: supabase db pull summary: Pull schema from the remote database description: |2 Pulls schema changes from a remote database. A new migration file will be created under `supabase/migrations` directory. Requires your local project to be linked to a remote database by running `supabase link`. For self-hosted databases, you can pass in the connection parameters using `--db-url` flag. Optionally, a new row can be inserted into the migration history table to reflect the current state of the remote database. If no entries exist in the migration history table, `pg_dump` will be used to capture all contents of the remote schemas you have created. Otherwise, this command will only diff schema changes against the remote database, similar to running `db diff --linked`. tags: [] links: [] usage: supabase db pull [migration name] [flags] subcommands: [] flags: - id: db-url name: --db-url description: | Pulls from the database specified by the connection string (must be percent-encoded). default_value: '' - id: linked name: --linked description: Pulls from the linked project. default_value: 'true' - id: local name: --local description: Pulls from the local database. default_value: 'false' - id: password name: -p, --password description: Password to your remote Postgres database. default_value: '' - id: schema name: -s, --schema description: Comma separated list of schema to include. default_value: '[]' - id: supabase-db-lint title: supabase db lint summary: Checks local database for typing error description: |2 Lints local database for schema errors. Requires the local development stack to be running when linting against the local database. To lint against a remote or self-hosted database, specify the `--linked` or `--db-url` flag respectively. Runs `plpgsql_check` extension in the local Postgres container to check for errors in all schemas. The default lint level is `warning` and can be raised to error via the `--level` flag. To lint against specific schemas only, pass in the `--schema` flag. examples: - id: basic-usage name: Basic usage code: supabase db lint response: | Linting schema: public No schema errors found - id: schema-warnings name: Warnings for a specific schema code: supabase db lint --level warning --schema storage response: | Linting schema: storage [ { "function": "storage.search", "issues": [ { "level": "warning", "message": "unused variable \"_bucketid\"", "sqlState": "00000" } ] } ] tags: [] links: [] usage: supabase db lint [flags] subcommands: [] flags: - id: db-url name: --db-url description: | Lints the database specified by the connection string (must be percent-encoded). default_value: '' - id: level name: --level <[ warning | error ]> description: Error level to emit. default_value: warning accepted_values: - id: warning name: warning type: '[ warning | error ]' - id: error name: error type: '[ warning | error ]' - id: linked name: --linked description: Lints the linked project for schema errors. default_value: 'false' - id: local name: --local description: Lints the local database for schema errors. default_value: 'true' - id: schema name: -s, --schema description: Comma separated list of schema to include. default_value: '[]' - id: supabase-db-dump title: supabase db dump summary: Dumps data or schemas from the remote database description: |2 Dumps contents from a remote database. Requires your local project to be linked to a remote database by running `supabase link`. For self-hosted databases, you can pass in the connection parameters using `--db-url` flag. Runs `pg_dump` in a container with additional flags to exclude Supabase managed schemas. The ignored schemas include auth, storage, and those created by extensions. The default dump does not contain any data or custom roles. To dump those contents explicitly, specify either the `--data-only` and `--role-only` flag. examples: - id: basic-usage name: Basic usage code: supabase db dump -f supabase/schema.sql response: | Dumping schemas from remote database... Dumped schema to supabase/schema.sql. - id: role-only name: Role only code: supabase db dump -f supabase/roles.sql --role-only response: | Dumping roles from remote database... Dumped schema to supabase/roles.sql. - id: data-only name: Data only code: supabase db dump -f supabase/seed.sql --data-only response: | Dumping data from remote database... Dumped schema to supabase/seed.sql. tags: [] links: [] usage: supabase db dump [flags] subcommands: [] flags: - id: data-only name: --data-only description: Dumps only data records. default_value: 'false' - id: db-url name: --db-url description: | Dumps from the database specified by the connection string (must be percent-encoded). default_value: '' - id: dry-run name: --dry-run description: Prints the pg_dump script that would be executed. default_value: 'false' - id: file name: -f, --file description: File path to save the dumped contents. default_value: '' - id: keep-comments name: --keep-comments description: Keeps commented lines from pg_dump output. default_value: 'false' - id: linked name: --linked description: Dumps from the linked project. default_value: 'true' - id: local name: --local description: Dumps from the local database. default_value: 'false' - id: password name: -p, --password description: Password to your remote Postgres database. default_value: '' - id: role-only name: --role-only description: Dumps only cluster roles. default_value: 'false' - id: schema name: -s, --schema description: Comma separated list of schema to include. default_value: '[]' - id: use-copy name: --use-copy description: Uses copy statements in place of inserts. default_value: 'false' - id: supabase-db-diff title: supabase db diff summary: Diffs the local database for schema changes description: |2 Diffs schema changes made to the local or remote database. Requires the local development stack to be running when diffing against the local database. To diff against a remote or self-hosted database, specify the `--linked` or `--db-url` flag respectively. Runs [djrobstep/migra](https://github.com/djrobstep/migra) in a container to compare schema differences between the target database and a shadow database. The shadow database is created by applying migrations in local `supabase/migrations` directory in a separate container. Output is written to stdout by default. For convenience, you can also save the schema diff as a new migration file by passing in `-f` flag. By default, all schemas in the target database are diffed. Use the `--schema public,extensions` flag to restrict diffing to a subset of schemas. While the diff command is able to capture most schema changes, there are cases where it is known to fail. Currently, this could happen if you schema contains: - Changes to publication - Changes to storage buckets - Views with `security_invoker` attributes examples: - id: basic-usage name: Basic usage code: supabase db diff -f my_table response: | Connecting to local database... Creating shadow database... Applying migration 20230425064254_remote_commit.sql... Diffing schemas: auth,extensions,public,storage Finished supabase db diff on branch main. No schema changes found - id: linked-project name: Against linked project code: supabase db diff -f my_table --linked response: | Connecting to local database... Creating shadow database... Diffing schemas: auth,extensions,public,storage Finished supabase db diff on branch main. WARNING: The diff tool is not foolproof, so you may need to manually rearrange and modify the generated migration. Run supabase db reset to verify that the new migration does not generate errors. - id: specific-schema name: For a specific schema code: supabase db diff -f my_table --schema auth response: | Connecting to local database... Creating shadow database... Diffing schemas: auth Finished supabase db diff on branch main. No schema changes found tags: [] links: [] usage: supabase db diff [flags] subcommands: [] flags: - id: db-url name: --db-url description: | Diffs against the database specified by the connection string (must be percent-encoded). default_value: '' - id: file name: -f, --file description: Saves schema diff to a new migration file. default_value: '' - id: linked name: --linked description: Diffs local migration files against the linked project. default_value: 'false' - id: local name: --local description: Diffs local migration files against the local database. default_value: 'true' - id: schema name: -s, --schema description: Comma separated list of schema to include. default_value: '[]' - id: use-migra name: --use-migra description: Use migra to generate schema diff. default_value: 'true' - id: use-pgadmin name: --use-pgadmin description: Use pgAdmin 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) 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' - id: supabase-branches title: supabase branches summary: Manage Supabase preview branches tags: - management-api links: [] subcommands: - supabase-branches-create - supabase-branches-delete - supabase-branches-disable - supabase-branches-get - supabase-branches-list - supabase-branches-update flags: [] - id: supabase-branches-update title: supabase branches update summary: Update a preview branch description: Update a preview branch by its ID. tags: [] links: [] usage: supabase branches update [flags] subcommands: [] flags: - id: git-branch name: --git-branch description: Change the associated git branch. default_value: '' - id: name name: --name description: Rename the preview branch. default_value: '' - id: reset-on-push name: --reset-on-push description: Reset the preview branch on git push. default_value: 'false' - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: supabase-branches-list title: supabase branches list summary: List all preview branches description: List all preview branches of the linked project. tags: [] links: [] usage: supabase branches list subcommands: [] flags: - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: supabase-branches-get title: supabase branches get summary: Retrieve details of a preview branch description: Retrieve details of the specified preview branch. tags: [] links: [] usage: supabase branches get subcommands: [] flags: - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: supabase-branches-disable title: supabase branches disable summary: Disable preview branching description: Disable preview branching for the linked project. tags: [] links: [] usage: supabase branches disable subcommands: [] flags: - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: supabase-branches-delete title: supabase branches delete summary: Delete a preview branch description: Delete a preview branch by its ID. tags: [] links: [] usage: supabase branches delete subcommands: [] flags: - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false' - id: supabase-branches-create title: supabase branches create summary: Create a preview branch description: Create a preview branch for the linked project. tags: [] links: [] usage: supabase branches create [name] [flags] subcommands: [] flags: - id: region name: --region description: Select a region to deploy the branch database. default_value: '' accepted_values: - id: ams name: ams type: string - id: arn name: arn type: string - id: bog name: bog type: string - id: bos name: bos type: string - id: cdg name: cdg type: string - id: den name: den type: string - id: dfw name: dfw type: string - id: ewr name: ewr type: string - id: fra name: fra type: string - id: gdl name: gdl type: string - id: gig name: gig type: string - id: gru name: gru type: string - id: hkg name: hkg type: string - id: iad name: iad type: string - id: jnb name: jnb type: string - id: lax name: lax type: string - id: lhr name: lhr type: string - id: maa name: maa type: string - id: mad name: mad type: string - id: mia name: mia type: string - id: nrt name: nrt type: string - id: ord name: ord type: string - id: otp name: otp type: string - id: qro name: qro type: string - id: scl name: scl type: string - id: sea name: sea type: string - id: sin name: sin type: string - id: sjc name: sjc type: string - id: syd name: syd type: string - id: waw name: waw type: string - id: yul name: yul type: string - id: yyz name: yyz type: string - id: experimental name: --experimental description: enable experimental features required: true default_value: 'false'