> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.deel.com/cli/installation/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.deel.com/_mcp/server.

# Installation

> Install the Deel CLI with the installer, npm, or from source, and verify the download

The CLI is distributed as standalone binaries attached to each [GitHub release](https://github.com/letsdeel/deel-cli/releases) and as an npm package. Both distributions install the same `deel` command. Use the installer on macOS and Linux; use npm on Windows or where Node.js is already part of the toolchain.

## Prerequisites

**Node.js 22.18 or later**, for the npm method, the default Windows method, and installing from source. The macOS/Linux installer and the direct Windows binary download need no runtime at all; the resulting `deel` binary runs on its own.

## Install

#### Installer

Recommended on macOS and Linux. Downloads the standalone binary for your platform. The binary runs on its own, with no separate runtime such as Node.js required.

```bash
curl -fsSL https://cli.deel.com/install.sh | sh
```

The installer detects the operating system, CPU architecture, and C library (glibc or musl), downloads the matching binary, verifies its SHA-256 checksum against the release's `SHA256SUMS`, and places it in `/usr/local/bin` or, when that directory is not writable, in `~/.local/bin`.

To install a specific version, use its versioned URL:

```bash
curl -fsSL https://cli.deel.com/v0.1.1/install.sh | sh
```

| Variable              | Effect                                                                                        |
| --------------------- | --------------------------------------------------------------------------------------------- |
| `DEEL_INSTALL_DIR`    | Install location (default `/usr/local/bin`, then `~/.local/bin`)                              |
| `DEEL_VERSION`        | Release tag to install (default `latest`)                                                     |
| `DEEL_REQUIRE_COSIGN` | Set to `1` to abort when `cosign` is not installed instead of skipping signature verification |

#### npm

Requires Node.js 22.18 or later. Works on macOS, Linux, and Windows.

```bash
npm install -g @deel-org/cli
```

To run a single command without installing:

```bash
npx @deel-org/cli --help
```

#### Windows

Install through npm (requires Node.js 22.18 or later):

```powershell
npm install -g @deel-org/cli
```

Alternatively, download `deel-windows-x64.exe` from the [releases page](https://github.com/letsdeel/deel-cli/releases), rename it to `deel.exe`, and place it in a directory on your `PATH`.

> **Note**
>
> Windows has no keychain backend in the current release. Provide the token through the `DEEL_TOKEN` environment variable or `--token-stdin`. See [Authentication](/cli/authentication).

#### From source

Requires Node.js 22.18 or later. No build step is needed to run from source.

```bash
git clone https://github.com/letsdeel/deel-cli.git
cd deel-cli
npm ci
node src/main.ts --help
```

To compile a single-file binary for your machine:

```bash
npm run build      # -> dist/deel
./dist/deel --version
```

## Installing for an AI agent

Install the CLI on the machine or in the container where the agent executes commands, not only on your own. The installer downloads a binary with no runtime dependency, so the same command works on a developer machine, in a container, and in a hosted agent sandbox; use npm where Node.js is already present. See [Set up a coding agent](/cli/agents/setup).

## Verify the installation

```bash
deel --version
```

The command prints `deel <version>` and exits with status 0. Run `deel --help` to list the available command groups and global options.

## Verify a downloaded binary

Every release ships `SHA256SUMS`, a Sigstore bundle `SHA256SUMS.sigstore`, and the release public key `cosign.pub`. The installer checks the checksum automatically and verifies the signature when [cosign](https://docs.sigstore.dev/cosign/system_config/installation/) is installed. To verify a binary you downloaded manually:

#### Install cosign

#### macOS

```bash
brew install cosign
```

#### Linux

```bash
curl -sLO https://github.com/sigstore/cosign/releases/latest/download/cosign-linux-amd64
chmod +x cosign-linux-amd64 && sudo mv cosign-linux-amd64 /usr/local/bin/cosign
```

#### Download the release artifacts

Replace the version with the release you downloaded.

```bash
VERSION=v0.1.1
BASE=https://github.com/letsdeel/deel-cli/releases/download/$VERSION

curl -sLO $BASE/SHA256SUMS
curl -sLO $BASE/SHA256SUMS.sigstore
curl -sLO $BASE/cosign.pub
```

#### Verify the checksum file signature

```bash
cosign verify-blob \
  --key cosign.pub \
  --bundle SHA256SUMS.sigstore \
  --insecure-ignore-tlog \
  SHA256SUMS
```

Expected output: `Verified OK`.

> **Note**
>
> `--insecure-ignore-tlog` is required because the release pipeline does not upload to the Sigstore public transparency log. The integrity guarantee comes from `cosign.pub`, not from the log.

#### Verify the binary checksum

Run this in the directory that contains the downloaded binary.

#### Linux

```bash
sha256sum --check SHA256SUMS --ignore-missing
```

#### macOS

```bash
shasum -a 256 --check SHA256SUMS --ignore-missing
```

Expected output: `deel-<platform>: OK`.

## Upgrade

Upgrade using the same method you installed with:

| Installation method | Upgrade command                                                       |
| ------------------- | --------------------------------------------------------------------- |
| Installer           | Re-run the installer command; it replaces the binary in place         |
| npm                 | `npm install -g @deel-org/cli@latest`                                 |
| Windows binary      | Download the new `deel-windows-x64.exe` and replace the existing file |

## Uninstall

Remove the CLI with the command for your install method:

| Installation method | Command                          |
| ------------------- | -------------------------------- |
| Installer           | `rm "$(command -v deel)"`        |
| npm                 | `npm uninstall -g @deel-org/cli` |

Removing the CLI does not remove tokens stored in the OS keychain. Run `deel auth logout` for each environment before uninstalling, or remove the `deel` entries from your keychain manually. Local logs remain in the [log directory](/cli/usage/logging#log-location).

## Next steps

#### [Quickstart](/cli/quickstart)

Store a token and run your first command

#### [Authentication](/cli/authentication)

Understand where the CLI reads the token from and how it is stored

> Build apps and integrations that extend and enhance the Deel services.