From cabccad9918af01971870d7d41cdb5578cd62d11 Mon Sep 17 00:00:00 2001 From: Advay Patil Date: Wed, 18 Dec 2024 14:10:36 -0800 Subject: [PATCH] Add examples and description for Postgres login subcommand (#518) --- spiceaidocs/docs/cli/reference/login.md | 36 +++++++++++++++++++++---- 1 file changed, 31 insertions(+), 5 deletions(-) diff --git a/spiceaidocs/docs/cli/reference/login.md b/spiceaidocs/docs/cli/reference/login.md index 636c15212..0dce0ecec 100644 --- a/spiceaidocs/docs/cli/reference/login.md +++ b/spiceaidocs/docs/cli/reference/login.md @@ -1,6 +1,6 @@ --- -title: 'login' -sidebar_label: 'login' +title: "login" +sidebar_label: "login" pagination_prev: null pagination_next: null --- @@ -18,7 +18,7 @@ spice login [command] [flags] - `-h`, `--help` Print this help message - `-k`, `--key` string API key (for spice.ai) -#### Available Commands +#### Available Commands To Connect to Other Services - `abfs` Login to a Azure Storage Account - `databricks` Login to a Databricks instance @@ -30,14 +30,40 @@ spice login [command] [flags] - `snowflake` Login to a Snowflake warehouse - `spark` Login to a Spark Connect remote -#### Examples +### Examples ```shell spice login ``` -### Additional Example +#### Additional Example ```shell spice login --key ``` + +### Examples for Other Services + +### Postgres + +**Example 1**: + +```shell +spice login postgres --password +``` + +**Example 2**: + +```shell +spice login postgres -p +``` + +**Required Flags**: + +- `-p`, `--password` Password to your postgres user + +**Sample Output**: + +``` +2024/12/18 13:59:10 INFO Successfully logged in to Pg +```