DocsGetting StartedInstallation

Installation

Install the CLI

Open your terminal and run:

curl -fsSL https://raw.githubusercontent.com/shipeed/cli/main/install.sh | bash

You'll be asked for your computer password to complete the installation. This is your Mac/Linux login password — it won't be visible as you type. This is normal.

Once installed, verify it works:

shipeed --version

Install the VS Code Extension

1. Open VS Code

2. Go to Extensions (Cmd+Shift+X on Mac, Ctrl+Shift+X on Windows)

3. Search for **"Shipeed"**

4. Click **Install**

The Shipeed icon will appear in your sidebar. You can create projects from the command palette (Cmd+Shift+P → "Shipeed: Create New Project") or from the sidebar.

curl -fsSL https://raw.githubusercontent.com/shipeed/cli/main/install.sh | bash
shipeed --version