mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
chore: update cli reference docs to 1.11.3 (#9896)
* chore: update cli reference docs to 1.11.3 * chore: hide db test command
This commit is contained in:
Han Qiao authored and GitHub committed
1 parent
4f97255073
commit
d23a0d587c
1 file changed
+164
-15
+164
-15
@@ -1,7 +1,7 @@
|
||||
clispec: '001'
|
||||
info:
|
||||
id: cli
|
||||
version: 1.8.5
|
||||
version: 1.11.3
|
||||
title: Supabase CLI
|
||||
language: sh
|
||||
source: https://github.com/supabase/cli
|
||||
@@ -12,14 +12,49 @@ info:
|
||||
options: |-
|
||||
```sh
|
||||
--debug output debug logs to stderr
|
||||
--experimental enable experimental features
|
||||
-h, --help help for supabase
|
||||
--workdir string path to a Supabase project directory
|
||||
```
|
||||
tags:
|
||||
- id: local-dev
|
||||
title: Local Development
|
||||
- id: management-api
|
||||
title: Management APIs
|
||||
- id: other-commands
|
||||
title: Additional Commands
|
||||
commands:
|
||||
- id: supabase-test
|
||||
title: supabase test
|
||||
summary: Run tests on local Supabase containers
|
||||
tags:
|
||||
- local-dev
|
||||
links: []
|
||||
subcommands:
|
||||
- supabase-test-db
|
||||
options: |-
|
||||
```sh
|
||||
-h, --help help for test
|
||||
```
|
||||
- id: supabase-test-db
|
||||
title: supabase test db
|
||||
summary: Tests local database with pgTAP
|
||||
tags: []
|
||||
links: []
|
||||
usage: |-
|
||||
```sh
|
||||
supabase test db [flags]
|
||||
```
|
||||
subcommands: []
|
||||
options: |-
|
||||
```sh
|
||||
-h, --help help for db
|
||||
```
|
||||
- id: supabase-stop
|
||||
title: supabase stop
|
||||
summary: Stop all local Supabase containers
|
||||
tags: []
|
||||
tags:
|
||||
- local-dev
|
||||
links: []
|
||||
usage: |-
|
||||
```sh
|
||||
@@ -34,7 +69,8 @@ commands:
|
||||
- id: supabase-status
|
||||
title: supabase status
|
||||
summary: Show status of local Supabase containers
|
||||
tags: []
|
||||
tags:
|
||||
- local-dev
|
||||
links: []
|
||||
usage: |-
|
||||
```sh
|
||||
@@ -48,7 +84,8 @@ commands:
|
||||
- id: supabase-start
|
||||
title: supabase start
|
||||
summary: Start containers for Supabase local development
|
||||
tags: []
|
||||
tags:
|
||||
- local-dev
|
||||
links: []
|
||||
usage: |-
|
||||
```sh
|
||||
@@ -62,7 +99,8 @@ commands:
|
||||
- id: supabase-secrets
|
||||
title: supabase secrets
|
||||
summary: Manage Supabase secrets
|
||||
tags: []
|
||||
tags:
|
||||
- management-api
|
||||
links: []
|
||||
subcommands:
|
||||
- supabase-secrets-list
|
||||
@@ -121,7 +159,8 @@ commands:
|
||||
- id: supabase-projects
|
||||
title: supabase projects
|
||||
summary: Manage Supabase projects
|
||||
tags: []
|
||||
tags:
|
||||
- management-api
|
||||
links: []
|
||||
subcommands:
|
||||
- supabase-projects-create
|
||||
@@ -167,7 +206,8 @@ commands:
|
||||
- id: supabase-orgs
|
||||
title: supabase orgs
|
||||
summary: Manage Supabase organizations
|
||||
tags: []
|
||||
tags:
|
||||
- management-api
|
||||
links: []
|
||||
subcommands:
|
||||
- supabase-orgs-list
|
||||
@@ -193,7 +233,8 @@ commands:
|
||||
- id: supabase-migration
|
||||
title: supabase migration
|
||||
summary: Manage database migration scripts
|
||||
tags: []
|
||||
tags:
|
||||
- local-dev
|
||||
links: []
|
||||
subcommands:
|
||||
- supabase-migration-list
|
||||
@@ -234,7 +275,8 @@ commands:
|
||||
- id: supabase-login
|
||||
title: supabase login
|
||||
summary: Authenticate using an access token
|
||||
tags: []
|
||||
tags:
|
||||
- local-dev
|
||||
links: []
|
||||
usage: |-
|
||||
```sh
|
||||
@@ -248,7 +290,8 @@ commands:
|
||||
- id: supabase-link
|
||||
title: supabase link
|
||||
summary: Link to a Supabase project
|
||||
tags: []
|
||||
tags:
|
||||
- local-dev
|
||||
links: []
|
||||
usage: |-
|
||||
```sh
|
||||
@@ -264,7 +307,8 @@ commands:
|
||||
- id: supabase-init
|
||||
title: supabase init
|
||||
summary: Initialize a local project
|
||||
tags: []
|
||||
tags:
|
||||
- local-dev
|
||||
links: []
|
||||
usage: |-
|
||||
```sh
|
||||
@@ -278,7 +322,8 @@ commands:
|
||||
- id: supabase-gen
|
||||
title: supabase gen
|
||||
summary: Run code generation tools
|
||||
tags: []
|
||||
tags:
|
||||
- local-dev
|
||||
links: []
|
||||
subcommands:
|
||||
- supabase-gen-types
|
||||
@@ -321,7 +366,8 @@ commands:
|
||||
- id: supabase-functions
|
||||
title: supabase functions
|
||||
summary: Manage Supabase Edge functions
|
||||
tags: []
|
||||
tags:
|
||||
- management-api
|
||||
links: []
|
||||
subcommands:
|
||||
- supabase-functions-delete
|
||||
@@ -396,10 +442,111 @@ commands:
|
||||
-h, --help help for delete
|
||||
--project-ref string Project ref of the Supabase project.
|
||||
```
|
||||
- id: supabase-domains
|
||||
title: supabase domains
|
||||
summary: Manage custom domain names for Supabase projects
|
||||
tags:
|
||||
- management-api
|
||||
links: []
|
||||
subcommands:
|
||||
- supabase-domains-activate
|
||||
- supabase-domains-create
|
||||
- supabase-domains-delete
|
||||
- supabase-domains-get
|
||||
- supabase-domains-reverify
|
||||
options: |-
|
||||
```sh
|
||||
-h, --help help for domains
|
||||
--include-raw-output Include raw output (useful for debugging).
|
||||
--project-ref string Project ref of the Supabase project.
|
||||
```
|
||||
- id: supabase-domains-reverify
|
||||
title: supabase domains reverify
|
||||
summary: Re-verify the custom hostname config for your project.
|
||||
tags: []
|
||||
links: []
|
||||
usage: |-
|
||||
```sh
|
||||
supabase domains reverify [flags]
|
||||
```
|
||||
subcommands: []
|
||||
options: |-
|
||||
```sh
|
||||
-h, --help help for reverify
|
||||
```
|
||||
- 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: |-
|
||||
```sh
|
||||
supabase domains get [flags]
|
||||
```
|
||||
subcommands: []
|
||||
options: |-
|
||||
```sh
|
||||
-h, --help help for get
|
||||
```
|
||||
- id: supabase-domains-delete
|
||||
title: supabase domains delete
|
||||
summary: Deletes the custom hostname config for your project.
|
||||
tags: []
|
||||
links: []
|
||||
usage: |-
|
||||
```sh
|
||||
supabase domains delete [flags]
|
||||
```
|
||||
subcommands: []
|
||||
options: |-
|
||||
```sh
|
||||
-h, --help help for delete
|
||||
```
|
||||
- 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: |-
|
||||
```sh
|
||||
supabase domains create [flags]
|
||||
```
|
||||
subcommands: []
|
||||
options: |-
|
||||
```sh
|
||||
--custom-hostname string The custom hostname to use for your Supabase project.
|
||||
-h, --help help for create
|
||||
```
|
||||
- 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: |-
|
||||
```sh
|
||||
supabase domains activate [flags]
|
||||
```
|
||||
subcommands: []
|
||||
options: |-
|
||||
```sh
|
||||
-h, --help help for activate
|
||||
```
|
||||
- id: supabase-db
|
||||
title: supabase db
|
||||
summary: Manage local Postgres databases
|
||||
tags: []
|
||||
tags:
|
||||
- local-dev
|
||||
links: []
|
||||
subcommands:
|
||||
- supabase-db-branch
|
||||
@@ -514,6 +661,7 @@ commands:
|
||||
```sh
|
||||
-f, --file string Saves schema diff to a file.
|
||||
-h, --help help for diff
|
||||
--linked Diffs local schema against linked project.
|
||||
-s, --schema strings List of schema to include. (default [public])
|
||||
--use-migra Use migra to generate schema diff.
|
||||
```
|
||||
@@ -595,7 +743,8 @@ commands:
|
||||
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: []
|
||||
tags:
|
||||
- other-commands
|
||||
links: []
|
||||
subcommands:
|
||||
- supabase-completion-bash
|
||||
|
||||
Reference in new issue
Block a user