{"id":"akku1139/hono-ja:docs/agents/cli.md","repo":"akku1139/hono-ja","path":"docs/agents/cli.md","title":"Hono CLI","content":"# Hono CLI\n\nHono CLI (`hono`) は Hono のコマンドラインツールで、コーディングエージェント向けに作られています。 Hono アプリを直接読み込むため、エージェントはサーバーを起動せずにアプリを検査・テストできます。 コマンドはデフォルトで JSON を出力します。 人間が読むときは `routes`, `request`, `benchmark`, `ssg` に `--plain` を指定します。\n\n## インストール\n\nプロジェクトにインストールします。 コーディングエージェントは `package.json` からそれを見つけます。\n\n```sh\nnpm install -D @hono/cli\n```\n\nまたはグローバルに:\n\n```sh\nnpm install -g @hono/cli\n```\n\n## 出力\n\nコマンドは JSON を標準出力に出力します。 `snapshot` は代わりにバッチ JSONL 行を出力します。\n\n- 成功: `{ \"ok\": true, \"data\": ... }` 終了コード 0\n- 失敗: `{ \"ok\": false, \"error\": { \"code\", \"message\", \"suggestions\", \"docs\" } }` 終了コード 1\n\n失敗時、`error.suggestions` は次に試すべきことを示し、`error.docs` はこのサイトのページを指します。 ログは標準エラー出力に出力されます。\n\n`hono --help` はコーディングエージェント向けの短い注記から始まり、`hono --help` には各コマンドの例と注記があります。 エージェントが CLI を使うために必要なものは他にありません。\n\n## コマンド\n\n| コマンド | 内容 |\n| ---------------------------- | ------------------------------------------------------ |\n| `hono routes [file]` | Hono アプリのルートを表示します |\n| `hono request [path] [file]` | `app.request()` を使ってアプリにリクエストを送信します |\n| `hono batch [file]` | JSONL から複数のリクエストを `app.request()` で実行します |\n| `hono snapshot [file]` | 現在の挙動をバッチ JSONL 行として出力します |\n| `hono diff` | 未コミットの変更がアプリに与える影響を表示します |\n| `hono benchmark [file]` | Hono アプリのパフォーマンスを計測します |\n| `hono ssg [file]` | Hono アプリから静的ファイルを生成します |\n| `hono init` | 現在のディレクトリに Hono アプリを追加します |\n\n`file` はアプリファイルへのパスです。 省略された場合、アプリは `src/index.ts`, `src/index.tsx`, `src/index.js`, または `src/index.jsx` から見つけられます。 TypeScript と JSX がサポートされています。\n\n### routes\n\nHono アプリのすべてのルートを表示します。 [`showRoutes()`](/docs/helpers/dev#showroutes) のように。 ルートは実際のアプリインスタンスから解決されるため、マウントされたサブアプリや `basePath` が展開されます。\n\n```sh\nhono routes\nhono routes --verbose src/app.ts\n```\n\n- `--verbose` - ミドルウェアを含める\n- `--plain` - JSON の代わりに人間が読みやすい出力\n- `-e, --external ` - パッケージを外部としてマークする (複数回使用可能)\n\n```json\n{\n \"ok\": true,\n \"data\": {\n \"router\": \"SmartRouter + RegExpRouter\",\n \"routes\": [\n {\n \"method\": \"GET\",\n \"path\": \"/\",\n \"name\": \"[handler]\",\n \"isMiddleware\": false\n },\n {\n \"method\": \"POST\",\n \"path\": \"/posts\",\n \"name\": \"[handler]\",\n \"isMiddleware\": false\n }\n ]\n }\n}\n```\n\n### request\n\n`app.request()` を通じてアプリにリクエストを送信します。 サーバーは不要です。 `path` のデフォルトは `/` です。\n\n```sh\nhono request /\nhono request /users/123\nhono request /api/users -X POST -d '{\"name\":\"Alice\"}'\nhono request /todos -X POST -d 'title=milk'\nhono request /api/protected -H 'Authorization: Bearer token'\ncat payload.json | hono request /api/users -X POST -d @-\nhono request /api/users/123 --trace\nhono request / --runtime bun\n```\n\n- `-X, --method ` - HTTP メソッド (デフォルト: `GET`)\n- `-d, --data ` - リクエストボディ (`@file` はファイルを読み、`@-` は標準入力を読みます)。 JSON オブジェクトまたは配列は JSON として、それ以外はフォームとして送信されます。 ただし `-H` で `Content-Type` を設定した場合は除きます。\n- `-H, --header
` - カスタムヘッダー (複数回使用可能)\n- `--trace` - マッチしたルートを出力に含める\n- `--runtime ` - アプリを `node` (デフォルト), `bun`, `deno`, `workerd`, または `vite` で実行する\n- `--compact` - ヘッダーなしの一行 JSON\n- `--no-bindings` - ローカルの Cloudflare バインディングの読み込みをスキップする\n- `-w, --watch` - 変更を監視し、リクエストを再送する\n- `-o, --output ` - レスポンスボディをファイルに書き込む\n- `--plain` - curl のように生のボディを出力する (`-i` はステータスとヘッダーを追加、`-I` はそれらのみ表示)\n\nJSON レスポンスボディはオブジェクトとして埋め込まれます:\n\n```json\n{\n \"ok\": true,\n \"data\": {\n \"status\": 200,\n \"headers\": { \"content-type\": \"application/json\" },\n \"body\": { \"message\": \"Hello World\" }\n }\n}\n```\n\n`--trace` を使うと、出力に `matchedRoutes` が含まれます: どのミドルウェアとハンドラーがマッチし、どれが応答したかです。 404 の結果はそれを実行することを示唆します。\n\n`-` をファイルとして標準入力からアプリコードを渡すこともできます。 `app` は事前定義され、あなたのためにエクスポートされています:\n\n```sh\necho 'app.get(\"/hello\", (c) => c.json({ ok: true }))' | hono request /hello -\n```\n\n#### Cloudflare バインディング\n\nwrangler 設定があるプロジェクトでは、`c.env` が実際のローカルバインディング (KV, D1, R2, vars) を自動的に持ち、アプリは Node.js 上で実行されます。 これは `request`, `batch`, `snapshot`, `ssg` で動作します。 `--no-bindings` でスキップできます。 プロジェクトに [wrangler](https://developers.cloudflare.com/workers/wrangler/) がインストールされている必要があります。\n\n`--runtime workerd` は代わりに wrangler 設定と共にアプリ全体を workerd 内で実行します。 より重くなりますが、完全なランタイムです。 エントリは wrangler 設定の `main` なので、ファイル引数は渡さないでください。\n\n#### Vite\n\n`--runtime vite` は Vite プラグインがビルドするアプリ向けに、プロジェクトの Vite 開発サーバーを通してリクエストを送信します。 アプリは Vite 設定から取得されるため、ファイル引数は渡さないでください。 `cloudflare.config.ts` と Vite 設定があるプロジェクトでは `c.env` にバインディングがあり、デフォルトになります。 また `src/index.ts` がない Vite プロジェクトでもデフォルトです。 これは `request`, `batch`, `snapshot` で動作します。 ファイル引数、`--no-bindings`, `--trace`, `--watch` を指定すると、代わりに Node.js 上でアプリが実行されます。\n\n### batch\n\nJSONL から複数のリクエストを一回の呼び出しで順番に、一つのアプリインスタンスに対して実行します。 メモリ内状態はステップ間で引き継がれます。\n\n```sh\nhono batch - <<'JSONL'\n{\"path\":\"/users\",\"expect\":{\"status\":200}}\n{\"method\":\"POST\",\"path\":\"/users\",\"body\":{\"name\":\"Momo\"},\"expect\":{\"status\":201,\"body\":{\"name\":\"Momo\"}},\"save\":{\"id\":\".id\"}}\n{\"path\":\"/users/{{id}}\",\"expect\":{\"status\":200}}\n{\"method\":\"DELETE\",\"path\":\"/users/{{id}}\",\"expect\":{\"status\":204}}\nJSONL\n```\n\n一行に一つの JSON オブジェクト: `method`, `path`, `body`, `headers`, `expect`, `save`。\n\n- `expect` は受け入れ基準を宣言します。 `status` は完全一致です。 `body` は深い部分一致です: 宣言されたフィールドがマッチする必要があり、レスポンスの余分なフィールドは無視されます。\n- `save` はドットパスでレスポンスボディから値を保存し、後のステップで `{{id}}` として使用します。\n- 文字列の `body` はフォームとして送信されます。 または JSON オブジェクトや配列の場合は JSON として送信されます。 ただし `headers` でコンテンツタイプを設定した場合は除きます。 オブジェクトの `body` は JSON として送信されます。\n- Cookie はブラウザのように引き継がれます。 Cookie を設定するログインステップは、その後のステップをサインイン状態にします。 ステップ内の `cookie` ヘッダーが優先されます。\n- `expect` のないステップは 2xx または 3xx で合格し、4xx または 5xx で失敗します。 意図的に 4xx を受け入れるには、`expect.status` で宣言してください。\n- 失敗したステップは `diff` を持ち、不一致ごとに一行です。\n\n出力には各ステップの実際の `status` と `body`、ステップごとの `pass`、`summary` が含まれます。 `failed` が 0 になるまで再実行してください。\n\n- `-H, --header
` - すべてのステップに共有されるヘッダー\n- `--compact` - 失敗したステップとサマリーのみを出力する\n- `--runtime ` - `node` (default), `workerd`, or `vite`\n- `--no-bindings` - ローカルの Cloudflare バインディングの読み込みをスキップする\n\n### snapshot\n\nアプリの現在の挙動をバッチ JSONL 行として標準出力に出力します。 ファイルは書き込まれません。\n\n```sh\nhono snapshot\nhono snapshot --status-only src/app.ts\n```\n\nパラメータなしの GET ルートが実行され、その実際のステータスとボディが `expect` になります。 パラメータ付きの GET ルートは、アプリがすでにリンクやパラメータ名を持つ JSON フィールドでそのパスを示していた場合に実行されます。 その他のパラメータ付きルートと非 GET ルートは `expect` なしで出力されるため、あなたが記入します。 一つのプローブ行が、どのルートにもマッチしないパスのレスポンスを記録します。\n\n`routes` とは異なり、このコマンドは実際のリクエストを送信するため、ミドルウェアが実行されます。\n\nリファクタリング前にキャプチャし、`failed` が 0 になるまで `hono batch` で行を再実行してください。\n\n- `--status-only` - ボディではなくステータスコードのみをキャプチャする\n- `--runtime ` - `node` (default), `workerd`, or `vite`\n- `--no-bindings` - ローカルの Cloudflare バインディングの読み込みをスキップする\n\n### diff\n\n未コミットの変更がアプリに何をするかを表示します。 最後のコミット時と現在のアプリを実行し、答えを比較します。 事前のキャプチャは不要です。\n\n```sh\nhono diff\nhono diff --base main\n```\n\n- `--base ` - 比較対象のコミット (デフォルト: `HEAD`)\n\n`hono snapshot` が実行する GET ルートと 404 プローブが両側で実行されます。 `changed` は、ステータスとボディの差異と共に、異なる応答をしたものを一覧にします。 出現または消失したルートは `added` と `removed` に入ります。 その他のパラメータ付きルートと非 GET ルートは実行されないため、`hono batch` で確認してください。\n\n各側は最新のローカルデータを持つ一時的な git worktree で実行されるため、テスト中に書き込んだデータはカウントされません。 `node_modules` は共有され、`.dev.vars` はコピーされます。 リファクタリング後の空の `changed` は、GET ルートが以前と同じ応答をすることを意味します。\n\n```json\n{\n \"ok\": true,\n \"data\": {\n \"base\": \"HEAD\",\n \"compared\": 6,\n \"changed\": [\n { \"route\": \"GET /api/posts\", \"status\": \"200 -> 401\" }\n ],\n \"added\": [\"POST /login\"],\n \"removed\": []\n }\n}\n```\n\n### benchmark\n\nHono アプリのパフォーマンスを計測します。 ルーティングとハンドラーのマイクロベンチマークです: `app.request()` が HTTP スタックやネットワークなしで直接呼び出されます。 各実行は新しいプロセスで行われるため、結果は比較可能です。\n\n```sh\nhono benchmark\nhono benchmark -P /users\nhono benchmark -P /users -X POST -d '{\"name\":\"Alice\"}' -H 'Content-Type: application/json'\nhono benchmark --hono 4.12.3 --hono 4.13.0\nhono benchmark --hono ../hono\n```\n\n- `-P, --path ` - このパスのみをベンチマークする (複数回使用可能)\n- `-X`, `-d`, `-H` - `-P` パス用のメソッド、ボディ、ヘッダー\n- `--duration ` - 各ルートを計測する時間 (デフォルト: `500`)\n- `--warmup ` - 計測前のリクエスト数 (デフォルト: `30`)\n- `--hono ` - 別の Hono で同じアプリをベンチマークする: npm バージョン、またはローカルチェックアウト\n\n数パーセントの差はノイズです。 比較するには、複数回実行し、差が繰り返されるか確認してください。\n\n### ssg\n\nHono アプリから静的ファイルを生成します。 [SSG ヘルパー](/docs/helpers/ssg) のように。\n\n```sh\nhono ssg\nhono ssg -o dist/static src/app.ts\nhono ssg --exclude '/api/*'\n```\n\n- `-o, --outdir ` - 出力ディレクトリ (デフォルト: `static`)\n- `--include ` / `--exclude ` - パスでルートを選択する。 `*` は任意にマッチする\n- `--no-bindings` - ローカルの Cloudflare バインディングの読み込みをスキップする\n\n200 を返さないページは書き込まれません。 そのステータスと共に `skipped` に一覧されるため、`hono request ` で確認してください。\n\n```json\n{\n \"ok\": true,\n \"data\": {\n \"output\": \"static\",\n \"files\": [\"static/index.html\", \"static/about.html\"],\n \"skipped\": [{ \"path\": \"/counter\", \"status\": 500 }]\n }\n}\n```\n\n### init\n\n[create-hono](/docs/guides/create-hono) テンプレートから Hono アプリを現在のディレクトリに追加します。 `npm create hono` が使えない、すでに存在するプロジェクトで使用します。\n\n```sh\nnpm install -D @hono/cli\nnpx hono init --template cloudflare-workers --install\nnpx hono request /\n```\n\n- `-t, --template