[@layout]: ../docs.layout.md

# Install

PathMX runs on Bun. Each site installs and pins Core in its own `package.json`.

If you already have Bun 1.4+, go straight to the [Quickstart](./first-site.guide.md).
The installer below sets up Bun and a convenient global `pmx` launcher.

---

## Quick install

On macOS, Linux, or WSL, run this in your terminal as your normal user:

```sh
curl -fsSL https://docs.pathmx.dev/install.sh | bash
```

The installer reuses stable Bun 1.4+ or installs Bun with its official installer
when missing, then installs the newest `@pathmx/core@beta` and checks `pmx`.
Run it again to update the global launcher. Project versions stay pinned.
If an existing Bun is too old, it explains how to upgrade with your original
installation method. Installing Bun requires `curl` and `unzip`.

The command runs a downloaded script. You can [read the installer](/install.sh)
first, or download it for inspection before running:

```sh
curl --proto '=https' --proto-redir '=https' --tlsv1.2 -fsSL https://docs.pathmx.dev/install.sh -o pathmx-install.sh
less pathmx-install.sh
bash pathmx-install.sh
```

Bun's installer may update your shell profile. Follow any PATH instructions in
the output, then open a new terminal before running `pmx`.

For native Windows, or to control each step yourself, use the manual install below.

---

## 1. Install Bun manually

Install Bun 1.4 or newer from [bun.sh](https://bun.sh), then check its version.

```sh
bun --version
```

You should see `1.4.0` or higher.

---

## 2. Install the launcher

```sh
bun add --global @pathmx/core@beta
```

---

## 3. Check the command

```sh
pmx --version
```

You should see a version number. Outside a project it reports the
launcher; inside a project it reports that project's pinned Core.

Without a global install, `bunx @pathmx/core@beta init my-site` creates a
project directly, and `bun run pmx <command>` inside that project runs the
project-local CLI.

## Next

Already running PathMX? Use the [0.7 migration guide](./migrate-070.guide)
for the upgrade checklist and a copy/paste agent prompt.

[Quickstart](./first-site.guide.md)