Install the Jamdesk CLI on macOS, Linux, and Windows

The Jamdesk CLI is available through several installation methods so you can choose what fits your workflow and operating system. Global installation via npm is the most common approach and works on macOS, Linux, and Windows. Homebrew and the curl installer are popular on macOS and Linux, while PowerShell is the recommended path on Windows. If you’d rather skip a global install entirely, you can also run the CLI on demand with npx.

Install

npm
Homebrew
curl (macOS/Linux)
PowerShell (Windows)
npx

Install the jamdesk package globally using npm. This is the recommended method and works on all supported operating systems.

npm install -g jamdesk

After installation, the jamdesk command will be available in any terminal session. Upgrade to the latest version at any time with:

npm update -g jamdesk

On macOS or Linux, you can install Jamdesk through Homebrew by first adding the official tap, then installing the formula.

brew tap jamdesk/tap
brew install jamdesk

To upgrade an existing Homebrew installation:

brew upgrade jamdesk

The curl installer handles downloading, placing the binary, and updating your PATH automatically.

# Install the latest version
curl -fsSL https://get.jamdesk.com | bash

# Install a specific version
curl -fsSL https://get.jamdesk.com | bash -s -- --version 1.2.3

# Upgrade an existing installation
curl -fsSL https://get.jamdesk.com/upgrade | bash

# Uninstall
curl -fsSL https://get.jamdesk.com/uninstall | bash

On Windows, use PowerShell to install, upgrade, or uninstall the Jamdesk CLI.

# Install
iwr https://get.jamdesk.com/win | iex

# Upgrade
iwr https://get.jamdesk.com/upgrade | iex

# Uninstall
iwr https://get.jamdesk.com/uninstall | iex

No global install needed. Use npx to run Jamdesk commands on demand. npm will download the package automatically if it isn’t cached locally.

npx jamdesk dev

This is useful for one-off commands or CI environments where you don’t want to maintain a global installation. For regular development, a global install is faster since it skips the download step.

Verify Installation

Once installed, confirm the CLI is working by checking its version:

jamdesk --version

You should see the installed version number printed to your terminal. If the command is not found, ensure that your npm global bin directory is on your PATH, or restart your terminal session and try again.

Requirements

The Jamdesk CLI requires the following environment:

Node.js v20.0.0 or later
npm v8 or later (recommended)
Operating system: macOS, Linux, or Windows — all tested in CI

For a full list of environment requirements and compatibility notes, see the Requirements page.

Get Started

Development

Deployment

Migration

Troubleshooting

Install the Jamdesk CLI on macOS, Linux, and Windows

Install

Verify Installation

Requirements

Build docs developers (and LLMs) love

Get Started

Development

Deployment

Migration

Troubleshooting

Documentation Index

​Install

​Verify Installation

​Requirements

Build docs developers (and LLMs) love

Install

Verify Installation

Requirements