From a6edc75c71e02b6666495ea048232b680e0833e1 Mon Sep 17 00:00:00 2001 From: Qiao Han Date: Tue, 10 Jan 2023 23:47:35 +0800 Subject: [PATCH] chore: add command examples to cli reference --- spec/cli_v1_commands.yaml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/spec/cli_v1_commands.yaml b/spec/cli_v1_commands.yaml index fabffeb3733..0bef38793c5 100644 --- a/spec/cli_v1_commands.yaml +++ b/spec/cli_v1_commands.yaml @@ -528,6 +528,13 @@ commands: - id: supabase-login title: supabase login summary: Authenticate using an access token + examples: + - title: Basic usage + script: supabase login + output: | + You can generate an access token from https://app.supabase.com/account/tokens + Enter your access token: sbp_**************************************** + Finished supabase login. tags: - local-dev links: [] @@ -537,6 +544,17 @@ commands: - id: supabase-link title: supabase link summary: Link to a Supabase project + examples: + - title: Basic usage + script: supabase link --project-ref ******************** + output: | + Enter your database password: + Finished supabase link. + - title: Link without database password + script: supabase link --project-ref ******************** <<< "" + output: | + Enter your database password: + Finished supabase link. tags: - local-dev links: [] @@ -555,6 +573,13 @@ commands: - id: supabase-init title: supabase init summary: Initialize a local project + examples: + - title: Basic usage + script: supabase init + output: Finished supabase init. + - title: Initialise from an existing directory + script: supabase init --workdir . + output: Finished supabase init. tags: - local-dev links: []