jamdesk

library1.1.132jsnpmunverified

Jamdesk CLI (v1.1.132) is the official command-line tool for Jamdesk, a docs-as-code platform. It enables developers to initialize, preview, build, validate, and deploy MDX-based documentation sites with Turbopack-powered hot reload. Supports 50+ MDX components, three themes, OpenAPI auto-generation, AI search, and Mintlify migration. Requires Node.js >=20.0.0. Published weekly on npm with TypeScript types included.

devops

npm install jamdesk

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · JAMDESK

jamdesk

devopsjavascriptv1.1.132

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

jamdesk

✓ npx jamdesk dev

✗ jamdesk (without npx or global install)

Jamdesk is a CLI tool, not a library. Use npx or install globally. No programmatic import.

Installs the CLI globally, creates a new project, starts the dev server, validates the setup, and deploys.

# Install globally npm install -g jamdesk # Create a new docs project jamdesk init my-docs # Navigate to project cd my-docs # Start dev server with hot reload jamdesk dev # Validate configuration and MDX jamdesk validate # Deploy to Jamdesk (requires login) jamdesk login jamdesk deploy

Debug

Known issues

breakingNode.js >=20.0.0 is required. Older versions cause cryptic errors.

fix

Upgrade Node.js to version 20 or later.

affects: <20.0.0

deprecatedThe --all-langs flag is deprecated; use --lang for explicit language compilation.

fix

Use jamdesk dev --lang en (or your default language code) instead of --all-langs.

affects: >=1.1.0

gotchaRunning jamdesk dev without global install or npx will fail with 'command not found'.

fix

Use npx jamdesk dev or install globally with npm install -g jamdesk.

affects: *

gotchaJamdesk CLI does not expose a programmatic API; it is a command-line tool only.

fix

Do not attempt to require('jamdesk') in Node.js scripts. Use child_process exec/spawn instead.

affects: *

Errors

Common errors & fixes

Error: Could not find module 'jamdesk'

Trying to import jamdesk as a library instead of running it as a CLI.

fix

Use npx jamdesk dev or install globally and run jamdesk dev from the terminal.

node:internal/modules/cjs/loader:1031 throw err; Error: Cannot find module 'jamdesk'

Running jamdesk command without global installation or npx.

fix

Install globally: npm install -g jamdesk, or use npx jamdesk dev.

Error: The engine "node" is incompatible with this module. Expected version ">=20.0.0". Got "18.x.x"

Node.js version is below the required 20.0.0.

fix

Upgrade Node.js to 20 or later using nvm or official installer.

Error: Invalid docs.json: missing field 'name'

The docs.json file in the project root is missing required fields.

fix

Run jamdesk init to generate a valid docs.json, or refer to the documentation for required fields.

Upgrade

Version history

1.1.132latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

9 hits · last 30 days

node

Resources

githubhttps://github.com/jamdesk/jamdesk-cli ↗

packagejamdesk ↗

homepagehttps://www.jamdesk.com ↗