Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Windows installation #205

Merged
merged 1 commit into from
Apr 18, 2024
Merged

Document Windows installation #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions spiceaidocs/docs/cli/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,29 @@ sidebar_position: 11
pagination_prev: null
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

The Spice CLI is a set of commands to create and manage Spicepods and interact with the Spice runtime.

## Install

The Spice CLI can be installed by:

- Running `curl https://install.spiceai.org | /bin/bash`
- Downloading the binary from [GitHub Releases](https://github.com/spiceai/spiceai/releases)
<Tabs>
<TabItem value="default" label="macOS, Linux, and WSL" default>
- Running `curl https://install.spiceai.org | /bin/bash`
- Using `brew`: `brew install spiceai/spiceai/spice`
- Downloading the binary from [GitHub Releases](https://github.com/spiceai/spiceai/releases)
</TabItem>
<TabItem value="windows" label="Windows" default>
- Shell command
```bash
curl -L "https://install.spiceai.org/Install.ps1" -o Install.ps1 && PowerShell -ExecutionPolicy Bypass -File ./Install.ps1
```
- Downloading the binary from [GitHub Releases](https://github.com/spiceai/spiceai/releases)
</TabItem>
</Tabs>

The `spice` program will be added to the PATH automatically for **bash**, **fish**, and **zsh** shells.

Expand Down
30 changes: 21 additions & 9 deletions spiceaidocs/docs/getting-started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ description: 'Get started with Spice in 5 minutes'
pagination_next: null
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<div className="video-container">
<iframe width="560" height="420" src="https://www.youtube.com/embed/AZyrecVWnEs?si=2s_2jLTJlUdgItyC" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
</div>
Expand All @@ -14,15 +17,24 @@ pagination_next: null

**Step 1.** Install the Spice CLI:

```bash
curl https://install.spiceai.org | /bin/bash
```

Or using `brew`:

```bash
brew install spiceai/spiceai/spice
```
<Tabs>
<TabItem value="default" label="macOS, Linux, and WSL" default>
```bash
curl https://install.spiceai.org | /bin/bash
```

Or using `brew`:

```bash
brew install spiceai/spiceai/spice
```
</TabItem>
<TabItem value="windows" label="Windows" default>
```bash
curl -L "https://install.spiceai.org/Install.ps1" -o Install.ps1 && PowerShell -ExecutionPolicy Bypass -File ./Install.ps1
```
</TabItem>
</Tabs>

**Step 2.** Initialize a new Spice app with the `spice init` command:

Expand Down