# Installation (/vela-pro/get-started/setup)



Install Vela Pro by building your clone of the repository, packing the root package and its workspace modules into `.tgz` tarballs, and installing those tarballs in your application alongside Vela's open-source core (`@luxalgo/vela`). This produces a standard `node_modules` tree with a single deduplicated copy of the core and requires no custom bundler aliases.

After installation, your application's `package.json` contains entries like these:

```json
{
    "dependencies": {
        "@luxalgo/vela": "^0.10.9",
        "@luxalgo/vela-pro": "file:vendor/luxalgo-vela-pro-0.5.12.tgz",
        "@luxalgo/vela-pro-alerts": "file:vendor/luxalgo-vela-pro-alerts-0.1.2.tgz",
        "@luxalgo/vela-pro-dom": "file:vendor/luxalgo-vela-pro-dom-0.1.2.tgz",
        "@luxalgo/vela-pro-watchlist": "file:vendor/luxalgo-vela-pro-watchlist-0.1.2.tgz"
    }
}
```

The commands below assume the repository clone (`Vela-pro/`) and your application (`my-app/`) sit side by side. Adjust relative paths to match your directory layout.

<Steps>
  <Step title="Clone the repository">
    ```bash
    git clone https://github.com/LuxAlgo/Vela-pro.git
    cd Vela-pro
    ```

    `LuxAlgo/Vela-pro` is a private repository. If cloning is rejected, complete the steps in [Repository access](/vela-pro/get-started/access).
  </Step>

  <Step title="Install dependencies and build">
    ```bash
    npm install
    npm run build:plugins
    ```

    `npm install` resolves all dependencies from the public npm registry or from vendored archives inside the repository, and compiles `@luxalgo/vela-pro` into `dist/`.

    `npm run build:plugins` compiles the six domain module workspaces under `plugins/` (referred to as plugins in the API), which are not built by the root `prepare` script alone.
  </Step>

  <Step title="Pack Vela Pro and its modules">
    ```bash
    mkdir ../my-app/vendor
    npm pack --workspaces --include-workspace-root --pack-destination ../my-app/vendor
    ```

    Create `../my-app/vendor` before running `npm pack`, because `npm pack` does not create missing destination folders. The command writes seven `.tgz` archives into `vendor/`:

    | Tarball                                | Contents                                     | When to install                          |
    | -------------------------------------- | -------------------------------------------- | ---------------------------------------- |
    | `luxalgo-vela-pro-0.5.12.tgz`          | Core Vela Pro features and `enableVelaPro()` | Always                                   |
    | `luxalgo-vela-pro-alerts-0.1.2.tgz`    | Alerts module                                | Always                                   |
    | `luxalgo-vela-pro-dom-0.1.2.tgz`       | Order Book (DOM) module                      | Always                                   |
    | `luxalgo-vela-pro-watchlist-0.1.2.tgz` | Watchlist module                             | Always                                   |
    | `luxalgo-vela-pro-trading-0.1.2.tgz`   | Trading module                               | When enabling Trading                    |
    | `luxalgo-vela-pro-journal-0.1.2.tgz`   | Journal module                               | When enabling Journal (requires Trading) |
    | `luxalgo-vela-pro-calendar-0.1.2.tgz`  | Calendar module                              | When enabling Calendar                   |
  </Step>

  <Step title="Install the tarballs in your application">
    ```bash
    cd ../my-app
    npm install "@luxalgo/vela@^0.10.9" ./vendor/luxalgo-vela-pro-0.5.12.tgz ./vendor/luxalgo-vela-pro-alerts-0.1.2.tgz ./vendor/luxalgo-vela-pro-dom-0.1.2.tgz ./vendor/luxalgo-vela-pro-watchlist-0.1.2.tgz
    ```

    Pass `@luxalgo/vela-pro` and the three default module tarballs (`-alerts`, `-dom`, `-watchlist`) in a single `npm install` command. Because `@luxalgo/vela-pro` depends on exact versions of those three packages that are not published on the public npm registry, installing `luxalgo-vela-pro-0.5.12.tgz` by itself fails with an HTTP 404 for `@luxalgo/vela-pro-alerts`.

    Include `@luxalgo/vela@^0.10.9` in the same command because your application code imports `@luxalgo/vela/workspace` directly, within the peer version range accepted by Vela Pro. Public transitive dependencies (`@luxalgo/vela-ui`, `@luxalgo/vela-pinets`, and `pinets`) are fetched automatically from npm.

    To install the opt-in Trading, Journal, or Calendar modules now or later, pass their tarballs the same way:

    ```bash
    npm install ./vendor/luxalgo-vela-pro-trading-0.1.2.tgz ./vendor/luxalgo-vela-pro-journal-0.1.2.tgz ./vendor/luxalgo-vela-pro-calendar-0.1.2.tgz
    ```

    Always install packed `.tgz` files rather than running `npm install ../Vela-pro`. Installing a directory path creates a symlink, causing imports inside `Vela-pro` to resolve against `Vela-pro/node_modules` instead of your application's `node_modules` and breaking Vite production builds.
  </Step>

  <Step title="Verify single-instance resolution">
    Confirm that npm resolved a single deduplicated copy of `@luxalgo/vela`:

    ```bash
    npm ls @luxalgo/vela
    ```

    Every line except one must report `deduped`:

    ```text
    my-app@0.0.0
    +-- @luxalgo/vela-pro-alerts@0.1.2
    | `-- @luxalgo/vela@0.10.9 deduped
    +-- @luxalgo/vela-pro-dom@0.1.2
    | `-- @luxalgo/vela@0.10.9 deduped
    +-- @luxalgo/vela-pro-watchlist@0.1.2
    | `-- @luxalgo/vela@0.10.9 deduped
    +-- @luxalgo/vela-pro@0.5.12
    | +-- @luxalgo/vela-pinets@0.3.4
    | | `-- @luxalgo/vela@0.10.9 deduped
    | `-- @luxalgo/vela@0.10.9 deduped
    `-- @luxalgo/vela@0.10.9
    ```

    Next, mount the minimal workspace from [Quickstart](/vela-pro/get-started/quickstart) and open the page in a browser. Confirm three visual elements that indicate Vela Pro is registered:

    * A **Replay** button in the topbar
    * A right-hand side rail with Watchlist, Alerts, Order Book, and Pine editor entries
    * **Footprint** and **TPO** options at the bottom of the chart style selector
  </Step>
</Steps>

<Warning>
  Your bundle must load a single instance of `@luxalgo/vela`. Vela Pro registers chart types, renderer layers, and panels into module-scoped registries inside `@luxalgo/vela`. When a second copy of `@luxalgo/vela` is installed, Vela Pro writes to one registry set while `VelaWorkspace` reads from the other, so the chart renders with zero console errors while all Vela Pro features remain absent (no Replay button, no side rail, and chart styles ending at Heikin Ashi).

  Always check `npm ls @luxalgo/vela`. If npm reports a peer dependency conflict on `@luxalgo/vela`, align your application's `@luxalgo/vela` version range instead of bypassing resolution with `--force` or `--legacy-peer-deps`.
</Warning>

## Team distribution and updates [#team-distribution-and-updates]

Because `package.json` references `file:vendor/...`, every developer workstation and CI environment running `npm install` must have the `.tgz` files present at those paths. Because the tarballs contain proprietary Vela Pro builds, review the [Developer License Agreement](https://www.luxalgo.com/licensing/) before choosing where those artifacts are stored.

When upgrading to a newer Vela Pro release, check out the updated version in your clone, re-run `npm install`, `npm run build:plugins`, and `npm pack`, and then re-run `npm install ./vendor/...` in your application with the tarball paths explicitly listed. Explicit tarball arguments are required even if a version number and filename did not change, because a bare `npm install` retains the previous checksum in `package-lock.json` and causes clean installs on other machines to fail with `EINTEGRITY`. See [Upgrading](/vela-pro/reference/upgrading) for release notes and migration steps.

## Verified environment [#verified-environment]

| Component                           | Version            |
| ----------------------------------- | ------------------ |
| `@luxalgo/vela-pro` and modules     | 0.5.12 and 0.1.2   |
| `@luxalgo/vela`, `@luxalgo/vela-ui` | 0.10.9, 0.4.2      |
| `@luxalgo/vela-pinets`, `pinets`    | 0.3.4, 0.13.1      |
| Node.js, npm                        | 24.18.0, 11.16.0   |
| Vite, TypeScript                    | 8.3.8, 7.0.2       |
| Browser                             | Microsoft Edge 157 |

The same installation workflow was verified with [React](/vela-pro/get-started/frameworks/react), [Next.js](/vela-pro/get-started/frameworks/nextjs), and [Vue](/vela-pro/get-started/frameworks/vue).
