> For the complete documentation index, see [llms.txt](https://docs.ecwid.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ecwid.com/site-themes/develop-site-themes/getting-started/install-crane-to-your-system.md).

# Install Crane to your system

To start working with the Crane tool, you need to install Crane and its dependencies on your system.

### Check system requirements <a href="#system-requirements" id="system-requirements"></a>

Before installing, ensure your system meets the following requirements:

* **Node.js**: Version 22 or higher
* **npm**: Version 10 or higher (comes with Node.js 22+)

{% hint style="success" icon="rectangle-terminal" %}
Use [nvm](https://github.com/nvm-sh/nvm) or [fnm](https://github.com/Schniz/fnm) to manage multiple Node.js versions.
{% endhint %}

### Create a project <a href="#create-a-project" id="create-a-project"></a>

Create a new directory for your application and install the required dependencies:

```bash
mkdir my-workspace && cd my-workspace
npm init -y
```

### Install dependencies <a href="#install-dependencies" id="install-dependencies"></a>

Install Crane and its required packages:

```bash
npm install vite vue @lightspeed/crane@latest @lightspeed/eslint-config-crane@latest
```

### Verify installation <a href="#verify-installation" id="verify-installation"></a>

Check that Crane is installed correctly:

```bash
npx @lightspeed/crane@latest --help
```

You should see a list of available commands including `init`, `build`, `preview`, and `deploy`.

### Troubleshooting <a href="#troubleshooting" id="troubleshooting"></a>

#### Command Not Found <a href="#command-not-found" id="command-not-found"></a>

If `npx @lightspeed/crane@latest` is not recognized, verify that Node.js and npm are installed and available in your `PATH`:

```bash
node --version   # Should print v22.x.x or higher
npm --version    # Should print 10.x.x or higher
```

#### Version Conflicts <a href="#version-conflicts" id="version-conflicts"></a>

If you have multiple Node.js versions installed, make sure the active version is 22 or higher:

```bash
nvm use 22
# or
fnm use 22
```

### Release Channels

Crane publishes to two npm dist-tags:

| dist-tag | What it points at                                                                                                                              | Install command                      |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| `latest` | Most recent **stable** release. The default when no tag is specified.                                                                          | `npm install @lightspeed/crane`      |
| `next`   | Preview channel. Usually points to the most recent **release candidate** (RC), and after a stable release it may point to that stable version. | `npm install @lightspeed/crane@next` |

You can also pin to a specific RC:

```bash
npm install @lightspeed/crane@3.5.5-rc.1
```

{% hint style="warning" %}
**Semver ranges never match RC versions**

Pre-release versions (e.g. `3.5.5-rc.0`) are excluded from `^` and `~` ranges by design. To consume RCs, you must either use the `@next` dist-tag or pin an exact RC version.
{% endhint %}

After a stable release ships, the `next` dist-tag is automatically advanced to that stable version, so anyone tracking `@next` always receives at least the most recent stable.

### Next Steps <a href="#next-steps" id="next-steps"></a>

* [Start with Crane app](/site-themes/develop-site-themes/getting-started/start-with-crane-app.md) — scaffold and preview your first application


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ecwid.com/site-themes/develop-site-themes/getting-started/install-crane-to-your-system.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.