diff --git a/spiceaidocs/content/en/cli/reference/_index.md b/spiceaidocs/content/en/cli/reference/_index.md index e338aea4..5a9ca5b0 100644 --- a/spiceaidocs/content/en/cli/reference/_index.md +++ b/spiceaidocs/content/en/cli/reference/_index.md @@ -16,21 +16,25 @@ spice [command] [--help] ## Full Command Reference -| Command | Description | -| ----------- | --------------------------------------------------------------------| -| add | Add Pod - adds a pod to the project | -| completion | Generate the autocompletion script for the specified shell | -| dataset | Dataset operations | -| help | Help about any command | -| init | Initialize Pod - initializes a new pod in the project | -| login | Login to Spice.ai | -| run | Run Spice.ai - starts the Spice.ai runtime, installing if necessary | -| sql | Start an interactive SQL query session against the Spice.ai runtime | -| upgrade | Upgrades the Spice CLI to the latest release | -| version | Spice CLI version | +| Command | Description | +| -------------------------------------------------- | --------------------------------------------------------------------| +| [add]({{}}) | Add Pod - adds a pod to the project | +| [completion]({{}}) | Generate the autocompletion script for the specified shell | +| [dataset]({{}}) | Dataset operations | +| [datasets]({{}}) | Lists datasets loaded by the Spice runtime | +| help | Help about any command | +| [init]({{}}) | Initialize Pod - initializes a new pod in the project | +| [login]({{}}) | Login to Spice.ai | +| [models]({{}}) | Lists models loaded by the Spice runtime | +| [pods]({{}}) | Lists Spicepods loaded by the Spice runtime | +| [run]({{}}) | Run Spice.ai - starts the Spice.ai runtime, installing if necessary | +| [sql]({{}}) | Start an interactive SQL query session against the Spice.ai runtime | +| [status]({{}}) | Spice runtime status | +| [upgrade]({{}}) | Upgrades the Spice CLI to the latest release | +| [version]({{}}) | Spice CLI version | ## Command Flags All commands have a help flag **--help** or **-h** to print its usage documentation: -- **--help** | **-h** : Print the help message +- **--help** | **-h** : Print the help message \ No newline at end of file diff --git a/spiceaidocs/content/en/cli/reference/add.md b/spiceaidocs/content/en/cli/reference/add.md new file mode 100644 index 00000000..b9a7b685 --- /dev/null +++ b/spiceaidocs/content/en/cli/reference/add.md @@ -0,0 +1,23 @@ +--- +type: docs +title: "Add" +linkTitle: "add" +weight: 90 +--- + +Add Spicepod - adds a Spicepod to the project + +### Usage: +```shell +spice add [flags] +``` + +#### Flags: + - `-h`, `--help` Print this help message + +### Examples: +```shell +spice add spiceai/quickstart +``` + + diff --git a/spiceaidocs/content/en/cli/reference/completion.md b/spiceaidocs/content/en/cli/reference/completion.md new file mode 100644 index 00000000..95415c78 --- /dev/null +++ b/spiceaidocs/content/en/cli/reference/completion.md @@ -0,0 +1,23 @@ +--- +type: docs +title: "Completion" +linkTitle: "completion" +weight: 90 +--- + +Generate the autocompletion script for spice for the specified shell. +See each sub-command's help for details on how to use the generated script. + +### Usage: +```shell +spice completion [command] +``` +Available `command`s + - bash + - fish + - powershell + - zsh + +#### Flags: + - `-h`, `--help` Print this help message + \ No newline at end of file diff --git a/spiceaidocs/content/en/cli/reference/dataset.md b/spiceaidocs/content/en/cli/reference/dataset.md new file mode 100644 index 00000000..1ec2f576 --- /dev/null +++ b/spiceaidocs/content/en/cli/reference/dataset.md @@ -0,0 +1,19 @@ +--- +type: docs +title: "dataset" +linkTitle: "dataset" +weight: 90 +--- + +Dataset operations + +### Usage: +```shell +spice dataset [command] +``` + +Available `command`s: + - `configure`: Configure a dataset + +#### Flags: + - `-h`, `--help` Print this help message \ No newline at end of file diff --git a/spiceaidocs/content/en/cli/reference/datasets.md b/spiceaidocs/content/en/cli/reference/datasets.md new file mode 100644 index 00000000..34316d3a --- /dev/null +++ b/spiceaidocs/content/en/cli/reference/datasets.md @@ -0,0 +1,25 @@ +--- +type: docs +title: "datasets" +linkTitle: "datasets" +weight: 90 +--- + +Lists datasets loaded by the Spice runtime + +### Usage: +```shell +spice datasets [flags] +``` + +#### Flags: + - `-h`, `--help` help for datasets + +### Examples: +```shell +>>> spice datasets + +FROM NAME REPLICATION ACCELERATION DEPENDSON STATUS +spice.ai/eth.beacon.recent_slots eth_beacon_recent_slotsss false false Ready +spice.ai/eth.recent_blocks eth_rec_blocks false false Initializing +``` \ No newline at end of file diff --git a/spiceaidocs/content/en/cli/reference/init.md b/spiceaidocs/content/en/cli/reference/init.md new file mode 100644 index 00000000..6445c33f --- /dev/null +++ b/spiceaidocs/content/en/cli/reference/init.md @@ -0,0 +1,23 @@ +--- +type: docs +title: "init" +linkTitle: "init" +weight: 90 +--- +Initialize Spice app - initializes a new Spice app + +### Usage: +```shell +spice init [flags] +``` + +#### Flags: + - `-h`, `--help` Print this help message + +### Examples: +```shell +spice init +spice init +spice init my_app +``` + diff --git a/spiceaidocs/content/en/cli/reference/login.md b/spiceaidocs/content/en/cli/reference/login.md new file mode 100644 index 00000000..360c92ef --- /dev/null +++ b/spiceaidocs/content/en/cli/reference/login.md @@ -0,0 +1,27 @@ +--- +type: docs +title: "login" +linkTitle: "login" +weight: 90 +--- + +Login to Spice.ai + +### Usage: +```shell +spice login [command] [flags] +``` + +### Flags: + - `-h`, `--help` Print this help message + - `-k`, `--key` string API key (for spice.ai) + +#### Available Commands: + - `databricks` Login to a Databricks instance + - `dremio` Login to a Dremio instance + - `s3` Login to a s3 storage + +#### Examples: +```shell +spice login +``` diff --git a/spiceaidocs/content/en/cli/reference/models.md b/spiceaidocs/content/en/cli/reference/models.md new file mode 100644 index 00000000..e6a4e8f1 --- /dev/null +++ b/spiceaidocs/content/en/cli/reference/models.md @@ -0,0 +1,24 @@ +--- +type: docs +title: "models" +linkTitle: "models" +weight: 90 +--- + +Lists models loaded by the Spice runtime + +### Usage: +```shell +spice models [flags] +``` + +#### Flags: + - `-h`, `--help` help for models + +### Examples: +```shell +>>> spice models + +NAME FROM DATASETS STATUS +modlz file:/Users/jeadie/Downloads/model.onnx [] Ready +``` \ No newline at end of file diff --git a/spiceaidocs/content/en/cli/reference/pods.md b/spiceaidocs/content/en/cli/reference/pods.md new file mode 100644 index 00000000..01ccdda2 --- /dev/null +++ b/spiceaidocs/content/en/cli/reference/pods.md @@ -0,0 +1,25 @@ +--- +type: docs +title: "pods" +linkTitle: "pods" +weight: 90 +--- +Lists Spicepods loaded by the Spice runtime + +### Usage: +```shell +spice pods [flags] +``` + +#### Flags: + - `-h`, `--help` help for pods + +### Examples: +```shell +>>> spice pods + +VERSION NAME DATASETSCOUNT MODELSCOUNT DEPENDENCIESCOUNT +v1beta1 demo 2 1 0 +v1beta1 another_pod 3 0 1 +``` + diff --git a/spiceaidocs/content/en/cli/reference/run.md b/spiceaidocs/content/en/cli/reference/run.md new file mode 100644 index 00000000..52aa2f58 --- /dev/null +++ b/spiceaidocs/content/en/cli/reference/run.md @@ -0,0 +1,21 @@ +--- +type: docs +title: "run" +linkTitle: "run" +weight: 90 +--- +Run Spice.ai - starts the Spice.ai runtime, installing if necessary + +### Usage: +```shell +spice run [flags] +``` + +#### Flags: + - `-h`, `--help` Print this help message + +### Examples: +```shell +spice run +``` + diff --git a/spiceaidocs/content/en/cli/reference/sql.md b/spiceaidocs/content/en/cli/reference/sql.md new file mode 100644 index 00000000..527d68fe --- /dev/null +++ b/spiceaidocs/content/en/cli/reference/sql.md @@ -0,0 +1,35 @@ +--- +type: docs +title: "sql" +linkTitle: "sql" +weight: 90 +--- + +Start an interactive SQL query session against the Spice.ai runtime + +### Usage: +```shell +spice sql [flags] +``` + +#### Flags: + - `-h`, `--help` Print this help message + + +### Examples +```shell +$ spice sql +Welcome to the interactive Spice.ai SQL Query Utility! Type 'help' for help. + +show tables; -- list available tables +sql> show tables ++---------------+--------------------+---------------+------------+ +| table_catalog | table_schema | table_name | table_type | ++---------------+--------------------+---------------+------------+ +| datafusion | public | tmp_view_test | VIEW | +| datafusion | information_schema | tables | VIEW | +| datafusion | information_schema | views | VIEW | +| datafusion | information_schema | columns | VIEW | +| datafusion | information_schema | df_settings | VIEW | ++---------------+--------------------+---------------+------------+ +``` diff --git a/spiceaidocs/content/en/cli/reference/status.md b/spiceaidocs/content/en/cli/reference/status.md new file mode 100644 index 00000000..e3587ee8 --- /dev/null +++ b/spiceaidocs/content/en/cli/reference/status.md @@ -0,0 +1,26 @@ +--- +type: docs +title: "status" +linkTitle: "status" +weight: 90 +--- +Spice runtime status + +### Usage +```shell +spice status [flags] +``` + +#### Flags: + - `-h`, `--help` help for status + +### Examples: +```shell +>>> spice status + +NAME ENDPOINT STATUS +http 127.0.0.1:3000 Ready +flight 127.0.0.1:50051 Ready +metrics N/A Disabled +opentelemetry 127.0.0.1:50052 Ready +``` \ No newline at end of file diff --git a/spiceaidocs/content/en/cli/reference/upgrade.md b/spiceaidocs/content/en/cli/reference/upgrade.md new file mode 100644 index 00000000..c2af8ebd --- /dev/null +++ b/spiceaidocs/content/en/cli/reference/upgrade.md @@ -0,0 +1,21 @@ +--- +type: docs +title: "upgrade" +linkTitle: "upgrade" +weight: 90 +--- +Upgrades the Spice CLI to the latest release + +### Usage: +```shell +spice upgrade [flags] +``` + +#### Flags: + - `-h`, `--help` help for upgrade + +### Examples: +```shell +spice upgrade +``` + diff --git a/spiceaidocs/content/en/cli/reference/version.md b/spiceaidocs/content/en/cli/reference/version.md new file mode 100644 index 00000000..e5c52156 --- /dev/null +++ b/spiceaidocs/content/en/cli/reference/version.md @@ -0,0 +1,20 @@ +--- +type: docs +title: "version" +linkTitle: "version" +weight: 90 +--- +Spice CLI version + +### Usage: +```shell +spice version [flags] +``` + +#### Flags: + - `-h`, `--help` help for version + +### Examples: +```shell +spice version +``` \ No newline at end of file