Skip to content

Commit

Permalink
Add examples and description for Postgres login subcommand (spiceai#518)
Browse files Browse the repository at this point in the history
  • Loading branch information
Advayp committed Dec 18, 2024
1 parent b7d071f commit cabccad
Showing 1 changed file with 31 additions and 5 deletions.
36 changes: 31 additions & 5 deletions spiceaidocs/docs/cli/reference/login.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'login'
sidebar_label: 'login'
title: "login"
sidebar_label: "login"
pagination_prev: null
pagination_next: null
---
Expand All @@ -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
Expand All @@ -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 <API_KEY>
```

### Examples for Other Services

### Postgres

**Example 1**:

```shell
spice login postgres --password <password>
```

**Example 2**:

```shell
spice login postgres -p <password>
```

**Required Flags**:

- `-p`, `--password` Password to your postgres user

**Sample Output**:

```
2024/12/18 13:59:10 INFO Successfully logged in to Pg
```

0 comments on commit cabccad

Please sign in to comment.