CLI Overview

Create a new documentation project.

jamdesk init              # Interactive mode
jamdesk init my-docs      # Create in new directory

This creates a new project with:

• docs.json configuration file
• Sample MDX pages
• Recommended folder structure

Log in to Jamdesk via your browser. Required before deploying.

jamdesk login

Opens the Jamdesk dashboard in your browser for authentication. Credentials are stored locally in ~/.jamdeskrc.

Clear stored credentials.

jamdesk logout

Show the current authenticated user and verify your session is valid.

jamdesk whoami

Validate your docs.json configuration, MDX syntax, and OpenAPI specs.

jamdesk validate
jamdesk validate --skip-mdx

Checks for:

• Valid JSON syntax in docs.json
• Required fields (name, navigation)
• Valid theme values
• MDX syntax errors (e.g., unescaped < characters)
• OpenAPI spec validation (if configured)
• Schema compliance

Options:

Run this before deploying to catch errors early.

Scan your documentation for broken internal links.

jamdesk broken-links

Example output:

docs/getting-started.mdx:15 - /docs/quikstart
  Did you mean: /docs/quickstart

Found 1 broken link in 45 files.

Detects links to missing pages and typos. See Links & Navigation for details.

Auto-fix broken internal-link warnings that have an unambiguous target. Handles two categories:

• Typo'd anchors: a fragment like #instalation that clearly should be #installation
• Cross-locale anchor drift: a translated page renamed its headings, but links in that locale still point at the old English fragment

# Preview what would change without touching any files
jamdesk fix --dry-run

# Apply fixes (prompts for confirmation)
jamdesk fix

Example dry-run output:

Planned fixes:

  fr/ai/overview.mdx:9
    /fr/ai/selectors#ai-strategies  →  /fr/ai/selectors#stratégies-ia

(dry run — no files written)

A fix is only written when the corrected anchor resolves to a real heading in the target page. Ambiguous cases are left for manual review.

Options:

Check your documentation for spelling errors.

jamdesk spellcheck

Example output:

getting-started.mdx:14 - "recieve"
  └─ Did you mean: receive

Found 3 misspellings across 24 pages.
Tip: Run "jamdesk spellcheck --fix" to interactively fix or ignore words.

Uses an English dictionary with 150+ built-in tech terms (API, GraphQL, Kubernetes, React, etc.) so common jargon doesn't flag. Skips code blocks, inline code, frontmatter, JSX, URLs, and file paths. Currently English only; multi-language dictionary support is planned.

Options:

Interactive fix mode (--fix) steps through each unique misspelled word:

1/10  "recieve" — found in 3 files
      intro.mdx:14, setup.mdx:7, guide.mdx:22

? What do you want to do?
❯ Fix → receive (recommended)
  Fix → relieve
  Ignore in the future (add to docs.json)
  Skip

• Fix replaces the word with a suggestion across all files (prose-safe, so it won't modify code blocks or JSX attributes). Up to 3 suggestions are shown, with the best match marked as recommended.
• Ignore adds the word to spellcheck.ignore in your docs.json so it won't be flagged again
• Skip does nothing for this run

Changes are previewed and confirmed before applying.

Custom ignore list: Add project-specific terms to your docs.json:

{
  "spellcheck": {
    "ignore": ["YourProduct", "kubectl", "Terraform"]
  }
}

Your project name from docs.json is automatically ignored.

Validate a single OpenAPI specification file.

jamdesk openapi-check openapi.yaml
jamdesk openapi-check api/spec.json

Validates:

• Valid YAML/JSON syntax
• OpenAPI 3.x schema compliance
• Endpoint definitions
• $ref references resolve correctly

Rename a page and automatically update all references.

jamdesk rename docs/old-name.mdx docs/new-name.mdx

This will:

• Rename the file
• Update docs.json navigation
• Update links in all other MDX files
• Update snippet references

Use this instead of manual renaming to keep all references in sync.

Migrate documentation from Mintlify to Jamdesk.

jamdesk migrate

Detects your Mintlify config and converts it to Jamdesk format. In the same pass it renames deprecated components (e.g. CardGroup → Columns), relocates orphan snippet MDX files into /snippets/ and rewrites parent-relative imports, extracts inline components that use React hooks into /snippets/<name>.tsx with 'use client', and auto-fixes mechanical MDX syntax issues. Idempotent, so you can re-run it safely.

Upload your docs and trigger a build directly from the terminal.

jamdesk deploy
jamdesk deploy --detach
jamdesk deploy --full-rebuild

Progress is shown live as each build phase completes. Also available as jamdesk push.

Scaffold and deploy a Cloudflare Worker that proxies /docs on your own domain to your Jamdesk site.

jamdesk deploy-proxy cloudflare
jamdesk deploy-proxy cloudflare --slug myproject --domain example.com --skip-deploy --yes

Interactive by default: it checks Wrangler, verifies your Cloudflare account, auto-detects your slug from docs.json, generates the Worker files, and optionally deploys.

Check your environment and diagnose issues.

jamdesk doctor

Checks:

• Node.js version (requires v20+)
• npm version
• docs.json exists and is valid
• ~/.jamdesk cache status
• Write permissions

Run this if you're experiencing issues with the CLI.

Clear the ~/.jamdesk cache directory.

jamdesk clean

This removes cached dependencies and build artifacts. Use it to:

• Free up disk space
• Fix corrupted cache issues
• Force fresh dependency installation

Dependencies will be reinstalled on the next jamdesk dev.

Update the CLI to the latest version.

jamdesk update

You can also update manually:

npm update -g jamdesk