mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 01:15:03 +03:00
chore: update cli reference doc (#27868)
* chore: update cli reference doc * fix: update generated docs and seed section * fix: setup docs page redirect for cli --------- Co-authored-by: Qiao Han <qiao@supabase.io> Co-authored-by: Han Qiao <sweatybridge@gmail.com>
This commit is contained in:
7 files changed
+80
-28
No files matched your search
@@ -14,7 +14,7 @@ With TypeScript, `supabase-js` detects things like `not null` constraints and [g
|
||||
<RefSubLayout.EducationRow>
|
||||
<RefSubLayout.Details>
|
||||
|
||||
You can use the Supabase CLI to [generate the types](/docs/reference/cli/supabase-gen-types-typescript). You can also generate the types [from the dashboard](https://supabase.com/dashboard/project/_/api?page=tables-intro).
|
||||
You can use the Supabase CLI to [generate the types](/docs/reference/cli/supabase-gen-types). You can also generate the types [from the dashboard](https://supabase.com/dashboard/project/_/api?page=tables-intro).
|
||||
|
||||
</RefSubLayout.Details>
|
||||
<RefSubLayout.Examples>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
clispec: '001'
|
||||
info:
|
||||
id: cli
|
||||
version: 1.178.2
|
||||
version: 1.183.5
|
||||
title: Supabase CLI
|
||||
language: sh
|
||||
source: https://github.com/supabase/cli
|
||||
@@ -963,6 +963,31 @@ commands:
|
||||
usage: supabase services
|
||||
subcommands: []
|
||||
flags: []
|
||||
- id: supabase-seed
|
||||
title: supabase seed
|
||||
summary: Seed a Supabase project from supabase/config.toml
|
||||
tags:
|
||||
- local-dev
|
||||
links: []
|
||||
subcommands:
|
||||
- supabase-seed-buckets
|
||||
flags: []
|
||||
- id: supabase-seed-buckets
|
||||
title: supabase seed buckets
|
||||
summary: Seed buckets declared in [storage.buckets]
|
||||
tags: []
|
||||
links: []
|
||||
usage: supabase seed buckets
|
||||
subcommands: []
|
||||
flags:
|
||||
- id: linked
|
||||
name: --linked
|
||||
description: Seeds the linked project.
|
||||
default_value: 'false'
|
||||
- id: local
|
||||
name: --local
|
||||
description: Seeds the local database.
|
||||
default_value: 'true'
|
||||
- id: supabase-secrets
|
||||
title: supabase secrets
|
||||
summary: Manage Supabase secrets
|
||||
@@ -2466,21 +2491,27 @@ commands:
|
||||
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
|
||||
tags: []
|
||||
links: []
|
||||
usage: supabase gen types typescript [flags]
|
||||
usage: supabase gen types [flags]
|
||||
subcommands: []
|
||||
flags:
|
||||
- id: db-url
|
||||
name: --db-url <string>
|
||||
description: Generate types from a database url.
|
||||
default_value: ''
|
||||
- id: lang
|
||||
name: --lang <[ typescript | go | swift ]>
|
||||
description: Output language of the generated types.
|
||||
default_value: typescript
|
||||
accepted_values:
|
||||
- id: typescript
|
||||
name: typescript
|
||||
type: '[ typescript | go | swift ]'
|
||||
- id: go
|
||||
name: go
|
||||
type: '[ typescript | go | swift ]'
|
||||
- id: swift
|
||||
name: swift
|
||||
type: '[ typescript | go | swift ]'
|
||||
- id: linked
|
||||
name: --linked
|
||||
description: Generate types from the linked project.
|
||||
@@ -2502,6 +2533,17 @@ commands:
|
||||
name: -s, --schema <strings>
|
||||
description: Comma separated list of schema to include.
|
||||
default_value: '[]'
|
||||
- id: swift-access-control
|
||||
name: --swift-access-control <[ internal | public ]>
|
||||
description: Access control for Swift generated types.
|
||||
default_value: internal
|
||||
accepted_values:
|
||||
- id: internal
|
||||
name: internal
|
||||
type: '[ internal | public ]'
|
||||
- id: public
|
||||
name: public
|
||||
type: '[ internal | public ]'
|
||||
- id: supabase-gen-keys
|
||||
title: supabase gen keys
|
||||
summary: Generate keys for preview branch
|
||||
@@ -2827,11 +2869,12 @@ commands:
|
||||
- id: supabase-domains-activate
|
||||
title: supabase domains activate
|
||||
summary: Activate the custom hostname for a project
|
||||
description: |-
|
||||
description: |2
|
||||
|
||||
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 third-party auth providers will no longer function on the Supabase-provisioned subdomain. Please refer to [Prepare to activate your domain](/docs/guides/platform/custom-domains#prepare-to-activate-your-domain) section in our documentation to learn more about the steps you need to follow.
|
||||
tags: []
|
||||
links: []
|
||||
|
||||
@@ -40,10 +40,6 @@ commands:
|
||||
title: supabase gen types
|
||||
product: 'general'
|
||||
|
||||
- id: supabase-gen-types-typescript
|
||||
title: supabase gen types typescript
|
||||
product: 'general'
|
||||
|
||||
- id: supabase-secrets
|
||||
title: supabase secrets
|
||||
product: 'secrets'
|
||||
|
||||
@@ -100,12 +100,6 @@
|
||||
"title": "Generate types (Postgres schema)",
|
||||
"slug": "supabase-gen-types",
|
||||
"type": "cli-command"
|
||||
},
|
||||
{
|
||||
"id": "supabase-gen-types-typescript",
|
||||
"title": "Generate types (TypeScript)",
|
||||
"slug": "supabase-gen-types-typescript",
|
||||
"type": "cli-command"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -205,6 +199,24 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "category",
|
||||
"title": "Seed",
|
||||
"items": [
|
||||
{
|
||||
"id": "supabase-seed",
|
||||
"title": "Seed a Supabase project",
|
||||
"slug": "supabase-seed",
|
||||
"type": "cli-command"
|
||||
},
|
||||
{
|
||||
"id": "supabase-seed-buckets",
|
||||
"title": "Seed storage buckets from config file",
|
||||
"slug": "supabase-seed-buckets",
|
||||
"type": "cli-command"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "category",
|
||||
"title": "Inspect",
|
||||
|
||||
@@ -40,10 +40,6 @@ commands:
|
||||
title: supabase gen types
|
||||
product: 'general'
|
||||
|
||||
- id: supabase-gen-types-typescript
|
||||
title: supabase gen types typescript
|
||||
product: 'general'
|
||||
|
||||
- id: supabase-secrets
|
||||
title: supabase secrets
|
||||
product: 'secrets'
|
||||
|
||||
@@ -37,7 +37,7 @@ so we've been strategic about the changes we're making. We plan to follow this m
|
||||
### Type support
|
||||
|
||||
If you followed yesterday's announcement, you will have noticed that we added
|
||||
[type generators](https://supabase.com/docs/reference/cli/usage#supabase-gen-types-typescript) to the CLI.
|
||||
[type generators](https://supabase.com/docs/reference/cli/usage#supabase-gen-types) to the CLI.
|
||||
|
||||
```bash
|
||||
supabase start
|
||||
|
||||
@@ -1242,6 +1242,11 @@ module.exports = [
|
||||
source: '/docs/reference/cli/supabase-db-remote-commit',
|
||||
destination: '/docs/reference/supabase-db-pull',
|
||||
},
|
||||
{
|
||||
permanent: true,
|
||||
source: '/docs/reference/cli/supabase-gen-types-typescript',
|
||||
destination: '/docs/reference/supabase-gen-types',
|
||||
},
|
||||
|
||||
{
|
||||
permanent: true,
|
||||
|
||||
Reference in new issue
Block a user