Skip to content

Commit b6bf211

Browse files
JeadieJeadie
authored
Add comprehensive reference for CLI, including examples for new commands: models, datasets, status (#123)
* add comprehensive reference for CLI, including examples for new commands: models, datasets, status * no help subpage * fix subpage link title * fix dot pointing
1 parent 43b2215 commit b6bf211

File tree

14 files changed

+329
-13
lines changed

14 files changed

+329
-13
lines changed

‎spiceaidocs/content/en/cli/reference/_index.md‎

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,25 @@ spice [command] [--help]
1616

1717
## Full Command Reference
1818

19-
| Command | Description |
20-
| ----------- | --------------------------------------------------------------------|
21-
| add | Add Pod - adds a pod to the project |
22-
| completion | Generate the autocompletion script for the specified shell |
23-
| dataset | Dataset operations |
24-
| help | Help about any command |
25-
| init | Initialize Pod - initializes a new pod in the project |
26-
| login | Login to Spice.ai |
27-
| run | Run Spice.ai - starts the Spice.ai runtime, installing if necessary |
28-
| sql | Start an interactive SQL query session against the Spice.ai runtime |
29-
| upgrade | Upgrades the Spice CLI to the latest release |
30-
| version | Spice CLI version |
19+
| Command | Description |
20+
| -------------------------------------------------- | --------------------------------------------------------------------|
21+
| [add]({{<ref "cli/reference/add">}}) | Add Pod - adds a pod to the project |
22+
| [completion]({{<ref "cli/reference/completion">}}) | Generate the autocompletion script for the specified shell |
23+
| [dataset]({{<ref "cli/reference/dataset">}}) | Dataset operations |
24+
| [datasets]({{<ref "cli/reference/datasets">}}) | Lists datasets loaded by the Spice runtime |
25+
| help | Help about any command |
26+
| [init]({{<ref "cli/reference/init">}}) | Initialize Pod - initializes a new pod in the project |
27+
| [login]({{<ref "cli/reference/login">}}) | Login to Spice.ai |
28+
| [models]({{<ref "cli/reference/models">}}) | Lists models loaded by the Spice runtime |
29+
| [pods]({{<ref "cli/reference/pods">}}) | Lists Spicepods loaded by the Spice runtime |
30+
| [run]({{<ref "cli/reference/run">}}) | Run Spice.ai - starts the Spice.ai runtime, installing if necessary |
31+
| [sql]({{<ref "cli/reference/sql">}}) | Start an interactive SQL query session against the Spice.ai runtime |
32+
| [status]({{<ref "cli/reference/status">}}) | Spice runtime status |
33+
| [upgrade]({{<ref "cli/reference/upgrade">}}) | Upgrades the Spice CLI to the latest release |
34+
| [version]({{<ref "cli/reference/version">}}) | Spice CLI version |
3135

3236
## Command Flags
3337

3438
All commands have a help flag **--help** or **-h** to print its usage documentation:
3539

36-
- **--help** | **-h** : Print the help message
40+
- **--help** | **-h** : Print the help message

‎spiceaidocs/content/en/cli/reference/add.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
type: docs
3+
title: "Add"
4+
linkTitle: "add"
5+
weight: 90
6+
---
7+
8+
Add Spicepod - adds a Spicepod to the project
9+
10+
### Usage:
11+
```shell
12+
spice add [flags]
13+
```
14+
15+
#### Flags:
16+
- `-h`, `--help` Print this help message
17+
18+
### Examples:
19+
```shell
20+
spice add spiceai/quickstart
21+
```
22+
23+

‎spiceaidocs/content/en/cli/reference/completion.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
type: docs
3+
title: "Completion"
4+
linkTitle: "completion"
5+
weight: 90
6+
---
7+
8+
Generate the autocompletion script for spice for the specified shell.
9+
See each sub-command's help for details on how to use the generated script.
10+
11+
### Usage:
12+
```shell
13+
spice completion [command]
14+
```
15+
Available `command`s
16+
- bash
17+
- fish
18+
- powershell
19+
- zsh
20+
21+
#### Flags:
22+
- `-h`, `--help` Print this help message
23+

‎spiceaidocs/content/en/cli/reference/dataset.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
type: docs
3+
title: "dataset"
4+
linkTitle: "dataset"
5+
weight: 90
6+
---
7+
8+
Dataset operations
9+
10+
### Usage:
11+
```shell
12+
spice dataset [command]
13+
```
14+
15+
Available `command`s:
16+
- `configure`: Configure a dataset
17+
18+
#### Flags:
19+
- `-h`, `--help` Print this help message

‎spiceaidocs/content/en/cli/reference/datasets.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
type: docs
3+
title: "datasets"
4+
linkTitle: "datasets"
5+
weight: 90
6+
---
7+
8+
Lists datasets loaded by the Spice runtime
9+
10+
### Usage:
11+
```shell
12+
spice datasets [flags]
13+
```
14+
15+
#### Flags:
16+
- `-h`, `--help` help for datasets
17+
18+
### Examples:
19+
```shell
20+
>>> spice datasets
21+
22+
FROM NAME REPLICATION ACCELERATION DEPENDSON STATUS
23+
spice.ai/eth.beacon.recent_slots eth_beacon_recent_slotsss false false Ready
24+
spice.ai/eth.recent_blocks eth_rec_blocks false false Initializing
25+
```

‎spiceaidocs/content/en/cli/reference/init.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
type: docs
3+
title: "init"
4+
linkTitle: "init"
5+
weight: 90
6+
---
7+
Initialize Spice app - initializes a new Spice app
8+
9+
### Usage:
10+
```shell
11+
spice init [flags]
12+
```
13+
14+
#### Flags:
15+
- `-h`, `--help` Print this help message
16+
17+
### Examples:
18+
```shell
19+
spice init
20+
spice init <spice app name>
21+
spice init my_app
22+
```
23+

‎spiceaidocs/content/en/cli/reference/login.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
type: docs
3+
title: "login"
4+
linkTitle: "login"
5+
weight: 90
6+
---
7+
8+
Login to Spice.ai
9+
10+
### Usage:
11+
```shell
12+
spice login [command] [flags]
13+
```
14+
15+
### Flags:
16+
- `-h`, `--help` Print this help message
17+
- `-k`, `--key` string API key (for spice.ai)
18+
19+
#### Available Commands:
20+
- `databricks` Login to a Databricks instance
21+
- `dremio` Login to a Dremio instance
22+
- `s3` Login to a s3 storage
23+
24+
#### Examples:
25+
```shell
26+
spice login
27+
```

‎spiceaidocs/content/en/cli/reference/models.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
type: docs
3+
title: "models"
4+
linkTitle: "models"
5+
weight: 90
6+
---
7+
8+
Lists models loaded by the Spice runtime
9+
10+
### Usage:
11+
```shell
12+
spice models [flags]
13+
```
14+
15+
#### Flags:
16+
- `-h`, `--help` help for models
17+
18+
### Examples:
19+
```shell
20+
>>> spice models
21+
22+
NAME FROM DATASETS STATUS
23+
modlz file:/Users/jeadie/Downloads/model.onnx [] Ready
24+
```

‎spiceaidocs/content/en/cli/reference/pods.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
type: docs
3+
title: "pods"
4+
linkTitle: "pods"
5+
weight: 90
6+
---
7+
Lists Spicepods loaded by the Spice runtime
8+
9+
### Usage:
10+
```shell
11+
spice pods [flags]
12+
```
13+
14+
#### Flags:
15+
- `-h`, `--help` help for pods
16+
17+
### Examples:
18+
```shell
19+
>>> spice pods
20+
21+
VERSION NAME DATASETSCOUNT MODELSCOUNT DEPENDENCIESCOUNT
22+
v1beta1 demo 2 1 0
23+
v1beta1 another_pod 3 0 1
24+
```
25+

‎spiceaidocs/content/en/cli/reference/run.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
type: docs
3+
title: "run"
4+
linkTitle: "run"
5+
weight: 90
6+
---
7+
Run Spice.ai - starts the Spice.ai runtime, installing if necessary
8+
9+
### Usage:
10+
```shell
11+
spice run [flags]
12+
```
13+
14+
#### Flags:
15+
- `-h`, `--help` Print this help message
16+
17+
### Examples:
18+
```shell
19+
spice run
20+
```
21+

0 commit comments

Comments
 (0)