Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update cli reference doc #23432

Merged
merged 4 commits into from
May 28, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
84 changes: 82 additions & 2 deletions apps/docs/spec/cli_v1_commands.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
clispec: '001'
info:
id: cli
version: 1.163.6
version: 1.169.6
title: Supabase CLI
language: sh
source: https://github.com/supabase/cli
Expand Down Expand Up @@ -256,6 +256,14 @@ commands:
description: enable experimental features
required: true
default_value: 'false'
- id: linked
name: --linked
description: Connects to Storage API of the linked project.
default_value: 'true'
- id: local
name: --local
description: Connects to Storage API of the local database.
default_value: 'false'
- id: supabase-storage-mv
title: supabase storage mv
summary: Move objects from src to dst path
Expand All @@ -273,6 +281,14 @@ commands:
description: enable experimental features
required: true
default_value: 'false'
- id: linked
name: --linked
description: Connects to Storage API of the linked project.
default_value: 'true'
- id: local
name: --local
description: Connects to Storage API of the local database.
default_value: 'false'
- id: supabase-storage-ls
title: supabase storage ls
summary: List objects by path prefix
Expand All @@ -290,6 +306,14 @@ commands:
description: enable experimental features
required: true
default_value: 'false'
- id: linked
name: --linked
description: Connects to Storage API of the linked project.
default_value: 'true'
- id: local
name: --local
description: Connects to Storage API of the local database.
default_value: 'false'
- id: supabase-storage-cp
title: supabase storage cp
summary: Copy objects from src to dst path
Expand Down Expand Up @@ -319,6 +343,14 @@ commands:
description: enable experimental features
required: true
default_value: 'false'
- id: linked
name: --linked
description: Connects to Storage API of the linked project.
default_value: 'true'
- id: local
name: --local
description: Connects to Storage API of the local database.
default_value: 'false'
- id: supabase-stop
title: supabase stop
summary: Stop all local Supabase containers
Expand Down Expand Up @@ -477,7 +509,7 @@ commands:
- id: exclude
name: -x, --exclude <strings>
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,pg_prove]
Names of containers to not start. [gotrue,realtime,storage-api,imgproxy,kong,inbucket,postgrest,postgres-meta,studio,edge-runtime,logflare,vector,pgbouncer]
default_value: '[]'
- id: ignore-health-check
name: --ignore-health-check
Expand Down Expand Up @@ -1280,6 +1312,7 @@ commands:
- local-dev
links: []
subcommands:
- supabase-migration-fetch
- supabase-migration-list
- supabase-migration-new
- supabase-migration-repair
Expand Down Expand Up @@ -1525,6 +1558,27 @@ commands:
name: -p, --password <string>
description: Password to your remote Postgres database.
default_value: ''
- id: supabase-migration-fetch
title: supabase migration fetch
summary: Fetch migration files from history table
tags: []
links: []
usage: supabase migration fetch [flags]
subcommands: []
flags:
- id: db-url
name: --db-url <string>
description: |
Fetches migrations from the database specified by the connection string (must be percent-encoded).
default_value: ''
- id: linked
name: --linked
description: Fetches migration history from the linked project.
default_value: 'true'
- id: local
name: --local
description: Fetches migration history from the local database.
default_value: 'false'
- id: supabase-logout
title: supabase logout
summary: Log out and delete access tokens locally
Expand Down Expand Up @@ -1627,7 +1681,33 @@ commands:
links: []
subcommands:
- supabase-inspect-db
- supabase-inspect-report
flags: []
- id: supabase-inspect-report
title: supabase inspect report
summary: Generate a CSV output for all inspect commands
tags: []
links: []
usage: supabase inspect report [flags]
subcommands: []
flags:
- id: output-dir
name: --output-dir <string>
description: Path to save CSV files in
default_value: ''
- id: db-url
name: --db-url <string>
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
title: supabase inspect db
summary: Tools to inspect your Supabase database
Expand Down