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. The CLI stores credentials in ~/.jamdeskrc.

Clear stored credentials.

jamdesk logout

Show the logged-in user and verify the session.

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. It fixes two kinds:

• 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)

jamdesk fix writes a fix only when the corrected anchor resolves to a real heading on the target page. It leaves ambiguous cases 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.). Skips code blocks, inline code, frontmatter, JSX, URLs, and file paths. English only for now. Multi-language dictionaries are 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 in every file. It never changes code blocks or JSX attributes. The prompt shows up to 3 suggestions and marks the best match as recommended.
• Ignore adds the word to spellcheck.ignore in your docs.json. The word won't be flagged again.
• Skip does nothing for this run

You preview and confirm changes before they apply.

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

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

Spellcheck ignores your project name from docs.json.

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 update every reference to it.

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 renaming by hand. References stay in sync.

Migrate documentation from Mintlify to Jamdesk.

jamdesk migrate

Detects your Mintlify config and converts it to Jamdesk format. The same pass also:

• Renames deprecated components (e.g. CardGroup → Columns)
• Moves 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'
• Fixes mechanical MDX syntax issues

The command is idempotent. Re-running it is safe.

Download a project whose docs Jamdesk hosts (no GitHub) as a git repository, or merge new Jamdesk changes into a copy you already pulled.

jamdesk pull
jamdesk pull --project your-project
jamdesk pull --dir ./docs-copy

Edit the files, then run jamdesk deploy in that folder to publish them. Needs CLI 1.1.227 or later and git.

Upload your docs and trigger a build from the terminal.

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

The CLI shows each build phase as it 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 --yes

The command is interactive by default. It checks Wrangler, verifies your Cloudflare account, detects your slug from docs.json, generates the Worker files, and offers to deploy. --yes generates the files and stops. Deploy them with npx wrangler deploy from the output directory.

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 when the CLI misbehaves.

Clear the ~/.jamdesk cache directory.

jamdesk clean

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

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

The next jamdesk dev reinstalls dependencies.

Update the CLI to the latest version.

jamdesk update

You can also update manually:

npm update -g jamdesk