> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jolter.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install Jolter with the public scripts, verified release archives, or a source build.

Jolter ships as a native executable. The installer places the binary on your machine; `jolter setup` then creates command shims and prints shell-specific PATH instructions.

## Quick install

<CodeGroup>
  ```powershell Windows theme={null}
  irm https://get.jolter.dev/install.ps1 | iex
  ```

  ```bash Linux and macOS theme={null}
  curl -fsSL https://get.jolter.dev/install.sh | sh
  ```
</CodeGroup>

After installation:

```bash theme={null}
jolter --version
jolter setup
jolter doctor
```

<Warning>
  One-line installers execute remote code. Security-sensitive environments
  should download and review the script first or install a checksum-verified
  release archive.
</Warning>

## Inspect before running

<CodeGroup>
  ```powershell Windows theme={null}
  Invoke-WebRequest https://get.jolter.dev/install.ps1 -OutFile install-jolter.ps1
  Get-Content .\install-jolter.ps1
  .\install-jolter.ps1
  ```

  ```bash Linux and macOS theme={null}
  curl -fsSL https://get.jolter.dev/install.sh -o install-jolter.sh
  less install-jolter.sh
  sh install-jolter.sh
  ```
</CodeGroup>

Use your normal endpoint-security and code-review policy before executing any downloaded installer.

## Supported release targets

| Platform | Architecture  | Rust target                |
| -------- | ------------- | -------------------------- |
| Windows  | x64           | `x86_64-pc-windows-msvc`   |
| Linux    | x64           | `x86_64-unknown-linux-gnu` |
| macOS    | Intel x64     | `x86_64-apple-darwin`      |
| macOS    | Apple Silicon | `aarch64-apple-darwin`     |

WSL uses the Linux x64 build. Runtime providers can impose additional requirements, such as CPU features required by Bun artifacts.

## Manual release archive

Download the archive and sibling `.sha256` file from the matching GitHub release.

Archive names follow this shape:

```text theme={null}
jolter-v<version>-<rust-target>.tar.gz
jolter-v<version>-x86_64-pc-windows-msvc.zip
```

Verify before extraction:

<CodeGroup>
  ```bash Linux theme={null}
  sha256sum -c jolter-v0.3.0-x86_64-unknown-linux-gnu.tar.gz.sha256
  ```

  ```bash macOS theme={null}
  shasum -a 256 -c jolter-v0.3.0-aarch64-apple-darwin.tar.gz.sha256
  ```

  ```powershell Windows theme={null}
  $actual = (Get-FileHash .\jolter-v0.3.0-x86_64-pc-windows-msvc.zip -Algorithm SHA256).Hash.ToLowerInvariant()
  $actual
  Get-Content .\jolter-v0.3.0-x86_64-pc-windows-msvc.zip.sha256
  ```
</CodeGroup>

Compare the values, extract the archive, and place `jolter` or `jolter.exe` in a user-controlled directory on `PATH`. Then run:

```bash theme={null}
jolter setup
jolter doctor
```

Never install an archive whose checksum does not match.

## Build from source

Rust `1.85` or newer is required.

```bash theme={null}
git clone https://github.com/jolterjs/jolter.git
cd jolter
cargo build --release --locked
```

The executable is written to:

```text theme={null}
Windows: target/release/jolter.exe
Unix:   target/release/jolter
```

Run the quality gates before distributing a local build:

```bash theme={null}
cargo fmt --all -- --check
cargo clippy --workspace --all-targets --locked -- -D warnings
cargo test --workspace --all-targets --locked
```

## Upgrade

Run Jolter's built in `upgrade` command to update Jolter itself:

```bash theme={null}
jolter upgrade
```

After upgrading:

```bash theme={null}
jolter --version
jolter setup
jolter doctor
```

Refreshing shims ensures they point to the new Jolter executable.
Refreshing shims is done by the `setup` command.

## Remove Jolter

Jolter provides you with uninstallers similar to the installers at the start of the page.

<Warning>
  One-line uninstallers execute remote code. Security-sensitive environments
  should download and review the script first or install a checksum-verified
  release archive.
</Warning>

<CodeGroup>
  ```powershell Windows theme={null}
  irm https://get.jolter.dev/uninstall.ps1 | iex
  ```

  ```bash Linux and macOS theme={null}
  curl -fsSL https://get.jolter.dev/uninstall.sh | sh
  ```
</CodeGroup>

Use your normal endpoint-security and code-review policy before executing any downloaded uninstaller.

The above scripts will remove Jolter entirely from your system, however
removing Jolter does not modify project `jolter.json` files.


## Related topics

- [Mental model](/mental-model.md)
- [Release operations](/maintainers/releasing.md)
- [Report a vulnerability](/security/reporting.md)
- [Updating toolchains](/guides/updating-toolchains.md)