Skip to content

Commit 952698e

Browse files
authored
chore: update cli reference doc (supabase#37343)
* chore: update cli reference doc * chore: update cli reference doc * chore: update cli reference doc * chore: update cli reference doc * chore: update cli reference doc * chore: update cli reference doc * chore: update cli reference doc
1 parent d83ef08 commit 952698e

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

apps/docs/spec/cli_v1_commands.yaml

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
clispec: '001'
22
info:
33
id: cli
4-
version: 2.31.4
4+
version: 2.33.9
55
title: Supabase CLI
66
language: sh
77
source: https://github.com/supabase/cli
@@ -74,7 +74,7 @@ flags:
7474
name: --workdir <string>
7575
description: path to a Supabase project directory
7676
default_value: ''
77-
- id: 'yes'
77+
- id: "yes"
7878
name: --yes
7979
description: answer yes to all prompts
8080
default_value: 'false'
@@ -2250,6 +2250,7 @@ commands:
22502250
links: []
22512251
subcommands:
22522252
- supabase-gen-keys
2253+
- supabase-gen-signing-key
22532254
- supabase-gen-types
22542255
flags: []
22552256
- id: supabase-gen-types
@@ -2310,6 +2311,35 @@ commands:
23102311
- id: public
23112312
name: public
23122313
type: '[ internal | public ]'
2314+
- id: supabase-gen-signing-key
2315+
title: supabase gen signing-key
2316+
summary: Generate a JWT signing key
2317+
description: |
2318+
Securely generate a private JWT signing key for use in the CLI or to import in the dashboard.
2319+
2320+
Supported algorithms:
2321+
ES256 - ECDSA with P-256 curve and SHA-256 (recommended)
2322+
RS256 - RSA with SHA-256
2323+
tags: []
2324+
links: []
2325+
usage: supabase gen signing-key [flags]
2326+
subcommands: []
2327+
flags:
2328+
- id: algorithm
2329+
name: --algorithm <[ RS256 | ES256 ]>
2330+
description: Algorithm for signing key generation.
2331+
default_value: ES256
2332+
accepted_values:
2333+
- id: RS256
2334+
name: RS256
2335+
type: '[ RS256 | ES256 ]'
2336+
- id: ES256
2337+
name: ES256
2338+
type: '[ RS256 | ES256 ]'
2339+
- id: append
2340+
name: --append
2341+
description: Append new key to existing keys file instead of overwriting.
2342+
default_value: 'false'
23132343
- id: supabase-gen-keys
23142344
title: supabase gen keys
23152345
summary: Generate keys for preview branch
@@ -3572,6 +3602,10 @@ commands:
35723602
- id: xlarge
35733603
name: xlarge
35743604
type: string
3605+
- id: with-data
3606+
name: --with-data
3607+
description: Whether to clone production data to the branch database.
3608+
default_value: 'false'
35753609
- id: experimental
35763610
name: --experimental
35773611
description: enable experimental features

0 commit comments

Comments
 (0)