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.
By default, Jamdesk hosted docs live on a *.jamdesk.app subdomain. If you want your docs to appear at a subpath of your own domain — such as yoursite.com/docs — jamdesk deploy-proxy generates and deploys a Cloudflare Worker that transparently proxies requests from your domain to your Jamdesk site, with no changes required to your docs content or build pipeline.
Subcommand
Currently, deploy-proxy supports one target platform:
| Subcommand | Description |
|---|
cloudflare | Generate and deploy a Cloudflare Worker for subpath hosting |
Interactive Usage
Running the command without flags launches a step-by-step wizard:
jamdesk deploy-proxy cloudflare
- Wrangler setup — checks for an existing wrangler installation or prompts to install it
- Cloudflare authentication — opens the Cloudflare dashboard for OAuth, or uses an existing API token
- Account selection — if your Cloudflare login has access to multiple accounts, you choose which one to use
- Zone selection — pick the domain zone where the Worker will be routed
- Worker generation — writes the Worker files to your output directory
The default subpath is /docs.
Non-Interactive (CI) Usage
Pass flags to skip all prompts and run headlessly — useful in CI pipelines or scripted environments:
jamdesk deploy-proxy cloudflare --slug acme --domain example.com --path /docs --yes
Flags
| Option | Description |
|---|
--slug <slug> | Project slug, skips auto-detection from docs.json |
--domain <domain> | Target domain to route (e.g., yoursite.com) |
--path <path> | Subpath prefix to serve docs under (default: /docs) |
--output-dir <dir> | Directory to write generated files into (default: cloudflare-worker/) |
--skip-deploy | Generate Worker files only — do not deploy to Cloudflare |
--force | Overwrite the output directory if it already exists |
--yes | Skip all interactive prompts (CI mode) |
--verbose | Print detailed output during generation and deployment |
Generated Files
After the command runs, the output directory (default: cloudflare-worker/) contains the following files:
| File | Description |
|---|
index.js | The Cloudflare Worker script that proxies requests to your Jamdesk site |
wrangler.toml | Wrangler configuration file with your account ID, zone, and route settings |
package.json | Declares the wrangler dev dependency for the Worker project |
.gitignore | Excludes node_modules and other generated artifacts from version control |
Manual Deploy
If you used --skip-deploy or want to redeploy the Worker later without running the full wizard, use wrangler directly from the output directory:
Further Reading
For a full walkthrough of DNS configuration, route patterns, and troubleshooting, see the Cloudflare deployment guide.