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.

Jamdesk CLI includes a set of utility commands for keeping your environment healthy and your tooling up to date. These commands are smaller in scope than the core dev and deploy workflows, but they’re often the first thing to reach for when something isn’t working as expected — whether that’s a corrupted cache, a stale CLI version, or an OpenAPI spec that needs validation before it goes live.
Every command in the Jamdesk CLI supports a --verbose flag. Add it to any of the commands below to see detailed output — useful for diagnosing issues or understanding exactly what a command is doing under the hood.

​
jamdesk doctor

jamdesk doctor inspects your local environment and reports anything that could prevent the CLI or dev server from working correctly. Run it as a first step whenever you encounter unexpected behavior. The command checks:
  • Node.js version — confirms you’re running v20.0.0 or higher, as required by the CLI
  • Cache state — detects a corrupted or oversized ~/.jamdesk cache that might be causing slow builds
  • docs.json presence — verifies that a valid docs.json exists in the current directory
jamdesk doctor

​
jamdesk clean

jamdesk clean deletes the ~/.jamdesk cache directory, which stores downloaded dependencies and Turbopack build artifacts. This is the recommended fix when the dev server is slow to start or appears stuck due to a corrupted Turbopack state. Turbopack cache corruption can happen when the dev server is killed mid-build. After running jamdesk clean, the next jamdesk dev invocation will reinstall dependencies to ~/.jamdesk/node_modules — this first run will be slower than usual, but subsequent runs will be fast again. 
jamdesk clean

​
jamdesk update

jamdesk update upgrades the Jamdesk CLI to the latest published version. Use the --check flag if you want to see whether an update is available without actually installing it — useful in CI environments where you want to log the check without changing the installed tooling. 
jamdesk update           # Install the latest version
jamdesk update --check   # Check for a newer version without installing
FlagDescription
--checkReport whether a newer version is available; do not install

​
jamdesk openapi-check

jamdesk openapi-check validates a single OpenAPI spec file and reports a summary of its contents. It’s a quick way to confirm that a spec is well-formed before referencing it in docs.json or using it to generate API reference pages. The command reports the number of endpoints, schemas, and tags found in the spec. If the file uses the older Swagger 2.0 format rather than OpenAPI 3.x, the command will emit a warning — Jamdesk supports Swagger 2.0, but upgrading to OpenAPI 3.x is recommended. 
jamdesk openapi-check <path/to/spec>
Example: 
jamdesk openapi-check docs/api/openapi.yaml
Example output: 
✓ OpenAPI spec is valid
  Endpoints: 24
  Schemas: 18
  Tags: api, users, billing
To validate all OpenAPI specs referenced in your docs.json at once — along with your MDX syntax and navigation config — use jamdesk validate instead.

Build docs developers (and LLMs) love

Get started for freeTalk to us