shiichan

ターミナルから Cloudflare ドキュメントを検索! cf docs search が登場

こんにちは、しぃちゃんだよ!

Cloudflare Changelog developers.cloudflare.com

ドキュメントを探すためにブラウザへ切り替える、あの一手間がなくなるかも。今日は Cloudflare CLI の新コマンドを紹介するね!

なにが発表されたの?

Cloudflare の Changelog で、Cloudflare CLI 1.0.0-beta.16 が公開されたよ。このバージョンには cf docs search というコマンドが入っていて、人間もコーディングエージェントも、ターミナルを離れずに Cloudflare のドキュメントを探せるんだって。

なぜ重要なの?

コーディングエージェントに Cloudflare の作業をさせるとき、最新の正しいドキュメントを参照できるかどうかが大事になるよね。

このコマンドは、その入り口をひとつにまとめてくれるよ。ガイド、チュートリアル、サンプルを、Cloudflare の製品を横断して探せるの。

これで何が変わるの?

  • 作業中のターミナルから、やりたいことを書くだけでドキュメントが見つかる
  • 結果が JSON で返るので、エージェントやスクリプトが機械的に扱える
  • 見つけたページを Markdown で取得して、そのままエージェントに読ませられる

深く潜ってみよう

まずはインストール、または更新。npm, yarn, pnpm, bun のどれでも、cf パッケージを @latest でグローバルに入れるよ。npm ならこうだよ。

npm install --global cf@latest

あとは、やりたいことや質問をそのまま書くだけ。

cf docs search "proxy a DNS record"
cf docs search "rate limit requests with WAF"
cf docs search "schedule a worker"

仕様のポイントはこれだよ。

  • 公開されている最新のドキュメントを検索する
  • 順位付けされた結果を最大 5 件、JSON で返す
  • 各結果にはタイトル、説明、ドキュメントの URL が入る
  • インターネット接続が必要

エージェント向けの使い方も紹介されているよ。jq で先頭の結果の URL を取り出して、Accept: text/markdown ヘッダー付きでリクエストすると、ページ全体を Markdown で取得できるの。

url=$(cf docs search "proxy a DNS record" | jq -r '.[0].url')
curl -H "Accept: text/markdown" "$url"

それから、このバージョンには破壊的変更もあるよ。生成されるコマンド名が kebab-case になって、たとえば getCredits は get-credits になるんだって。コマンドやフラグの変更点の全体は、CLI のリリースノートで確認してね。

まとめ

  • Cloudflare CLI 1.0.0-beta.16 に cf docs search が追加
  • 最大 5 件の順位付き JSON 結果(タイトル・説明・URL)が返る
  • URL に Accept: text/markdown を付けるとページ全体を Markdown で取得できる
  • 生成コマンド名が kebab-case になる破壊的変更あり

Cloudflare を使いながらコーディングエージェントに作業させているみんなに、ぴったりの更新だよ!