Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/jamdesk/jamdesk-cli/llms.txt

Use this file to discover all available pages before exploring further.

Before installing Jamdesk, make sure your machine meets the requirements below. The CLI is tested against all supported platforms on every release, so any combination listed here is expected to work out of the box.

System Requirements

RequirementMinimum versionNotes
Node.jsv20.0.0 or laterLTS release recommended
npmv8 or laterInstalled alongside Node.js
Operating systemmacOS, Linux, or WindowsAll three are tested in CI

Check Your Versions

Run these commands in your terminal to confirm what you have installed:
node --version
npm --version
You should see output similar to:
v20.18.0
10.8.2
If node --version returns a version below v20.0.0, or if the command is not found, install or upgrade Node.js before continuing.

Installing Node.js

Download the current LTS release of Node.js from nodejs.org. The installer includes npm, so you won’t need to install it separately.
Even when using npx to run Jamdesk without a global install — for example, npx jamdesk dev — Node.js v20.0.0 or later is still required. The npx flag only skips the global installation step; it does not bundle its own Node.js runtime.

Next Steps

Once your environment meets the requirements above, you’re ready to install the CLI. See the installation guide for instructions on installing Jamdesk via npm, Homebrew, curl, or PowerShell.

Build docs developers (and LLMs) love