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.

Subpath hosting lets you serve your Jamdesk documentation at a path on your existing domain — for example, yoursite.com/docs — instead of a separate subdomain. This keeps your brand unified and avoids the SEO fragmentation that comes with running docs on a different host. The jamdesk deploy-proxy cloudflare command scaffolds and deploys a Cloudflare Worker that proxies requests from your chosen path to your Jamdesk site, with no changes required to your origin infrastructure.

​
Prerequisites

Before running the wizard, make sure you have:
  • A Cloudflare account with the target domain added as a zone
  • The wrangler CLI available (the wizard will help configure it if needed)
  • Your domain’s DNS managed through Cloudflare

​
Run the Wizard

From your project root, run: 
jamdesk deploy-proxy cloudflare
The interactive wizard walks you through the following steps:
  1. Wrangler setup — checks for an existing wrangler installation and guides configuration if missing
  2. Cloudflare authentication — opens your browser to authenticate with Cloudflare (supports multiple accounts)
  3. Zone selection — lists the domains available in your account so you can pick the target
  4. Worker generation — scaffolds all required files in the output directory and optionally deploys immediately

​
CI / Non-Interactive Mode

To run without any prompts — for example, in a CI pipeline or scripted environment — pass all required values as flags along with --yes: 
jamdesk deploy-proxy cloudflare \
  --slug acme \
  --domain example.com \
  --path /docs \
  --yes

​
Flags

FlagDescription
--slug <slug>Project slug, skipping auto-detection from docs.json
--domain <domain>Target domain to serve docs from (e.g., yoursite.com)
--path <path>URL path prefix for the docs (default: /docs)
--output-dir <dir>Directory to write generated files into (default: cloudflare-worker/)
--skip-deployGenerate the Worker files without deploying to Cloudflare
--forceOverwrite the output directory if it already exists
--yesSkip all interactive prompts (CI mode)

​
Generated Files

The wizard writes the following files into the output directory (default: cloudflare-worker/):
  • index.js — the Worker script that intercepts requests at your configured path and proxies them to your Jamdesk site
  • wrangler.toml — Cloudflare Worker configuration, including the route pattern derived from your domain and path, and the account and zone IDs collected during the wizard
  • package.json — declares wrangler as a dev dependency so the project is self-contained and installable
  • .gitignore — excludes node_modules and any local wrangler state from version control

​
Deploy the Worker

If you ran the wizard interactively and chose to deploy, the Worker is live as soon as the command finishes. If you used --skip-deploy or want to redeploy after editing the generated files, run: 
cd cloudflare-worker
npx wrangler deploy
The first npx wrangler deploy in a new directory will install wrangler locally into node_modules. Subsequent runs use the cached version and are significantly faster.
For more detail on Cloudflare Worker routing and advanced configuration, see the Cloudflare deployment guide.

Build docs developers (and LLMs) love

Get started for freeTalk to us