Catalog / Cloudflare Developer Platform
Workers, Cloudflare CLI - Search Cloudflare documentation with the Cloudflare CLI
Cloudflare CLI 1.0.0-beta.16 includes cf docs search, so you and your coding agent can find Cloudflare documentation without leaving the terminal. Search for guides, tutorials, and examples across Cloudflare products.
To install or update to the latest release:
npmyarnpnpmbunnpm install --global cf@latestyarn global add cf@latestpnpm add --global cf@latestbun add --global cf@latest
Describe what you want to do, or ask a question:
cf docs search "proxy a DNS record"
cf docs search "rate limit requests with WAF"
cf docs search "schedule a worker"
The command searches live Cloudflare documentation and returns up to five ranked JSON results. Each result includes a title, description, and documentation URL. An Internet connection is required.
Agents can parse the results and fetch a complete page as Markdown. For example, use jq to select the first result, then request its URL with the Accept: text/markdown header:
url=$(cf docs search "proxy a DNS record" | jq -r '.[0].url')
curl -H "Accept: text/markdown" "$url"
This release also standardizes generated command names to kebab-case. For example, cf accounts billing getCredits becomes cf accounts billing get-credits. For the full list of breaking command and flag changes, refer to the Cloudflare CLI release notes ↗︎.
For more information, refer to Find Cloudflare documentation with a coding agent.