CLI
edge は HTTP API のクライアントです。各コマンドは https://api.edge.deca-dev.com 向けの トークンで /v1 を呼び、そのコマンドに示された スコープ を必要とします。 インストールは CLI をインストールする を参照してください。
グローバルフラグ
| フラグ | 意味 |
|---|---|
--profile NAME | 使うプロファイル(API ホストとサインイン)。省略時は有効なプロファイル |
--workspace ID_OR_SLUG | 操作するワークスペース。省略時は組織の default ワークスペース |
-o, --output FORMAT | table、json、jsonl、tsv。出力 を参照 |
--fields a,b,c | 各結果のうち指定したフィールドだけを残す |
--jq EXPR | jq 式で JSON の結果を絞り込む。jq を別途インストールする必要はない |
--raw | --jq と併用し、文字列を引用符なしで出力する |
--pretty | JSON をインデントする |
--limit N | 一覧から最大 N 件を返す |
--all | ページングを最後までたどる |
--yes | 対話的な確認プロンプトを省略する |
--dry-run | 送信するリクエストを表示して終了する。何も変更しない |
--no-color | 装飾なしで出力する。NO_COLOR=1 でも同じ |
--debug | リクエストとレスポンスを標準エラー出力に記録する(トークンは伏せる) |
組織は常にトークンから決まります。--organization フラグはありません。
プロファイル
プロファイルは接続設定のまとまりで、呼び出す API ホストと使うサインインを決めます。 この環境の組み込みプロファイル名は edge.deca-dev.com です。
edge profile list
edge profile use edge.deca-dev.com
edge profile showサインインはプロファイルごとにシステムのキーチェーンに保存されます。設定は ~/.config/edge/config.toml(Windows では %AppData%\edge\config.toml)にあります。
プロジェクトのフォルダは edge link で公開先を固定できます。.edge/project.json が書き込まれます。
同じ設定が複数の場所で指定された場合は、フラグ、環境変数、.edge/project.json、設定ファイル、組み込みの 既定値の順に、最初に見つかったものが使われます。
環境変数
| 変数 | 意味 |
|---|---|
EDGE_CLIENT_ID, EDGE_CLIENT_SECRET | CI 用のマシン認証情報。CLI が実行のたびにトークンに交換する。CI で CLI を使う を参照 |
EDGE_TOKEN | そのまま使う パーソナルアクセストークン(edge_pat_…)またはアクセストークン。ほかのすべてより優先される |
EDGE_PROFILE | --profile と同じ |
EDGE_WORKSPACE | --workspace と同じ |
EDGE_OUTPUT | --output と同じ |
EDGE_AGENT=1 | プログラム向けの出力。JSON、色なし、プロンプトなし |
EDGE_NO_UPDATE_CHECK=1 | 新しいバージョンを確認しない |
NO_COLOR | 記号を使わない表示にする |
コーディングエージェントの下で動いていることを CLI が検出した場合も、EDGE_AGENT=1 とみなします。 --output を明示した場合はそちらが優先されます。
出力
| 形式 | 内容 |
|---|---|
table | 読みやすく桁をそろえた表。端末での既定 |
json | API のレスポンスそのまま。パイプやリダイレクト時の既定 |
jsonl | 1 行に 1 つの JSON オブジェクト。パイプ時の logs tail などストリームの既定 |
tsv | 見出し行のあとに、1 件ごとのタブ区切りの行 |
JSON 出力は API のレスポンス本文で、名前の変更はしません。そのため HTTP API とこのページは 同じフィールドを説明しています。
進捗メッセージ、プロンプト、エラーは標準エラー出力に出ます。標準出力には結果だけが出ます。
json モードのエラーは、API の エラー形式 に HTTP ステータスと対処のヒントを加えたものです。
{"error":{"code":"forbidden","message":"missing scope deployment.promote","status":403,"hint":"run \"edge whoami\" to see your scopes"}}終了コード
| コード | 意味 |
|---|---|
0 | 成功 |
1 | その他の失敗。ネットワーク、サーバーエラー |
2 | 使い方の誤り。確認が必要なのに問い合わせる端末がない場合を含む |
3 | サインインしていない、またはトークンが期限切れか別の audience 向け |
4 | 禁止。スコープ不足、または組織外のワークスペース |
5 | このワークスペースに見つからない |
6 | 競合または検証エラー |
7 | 再試行後もレート制限 |
8 | 待機中に deployment が failed で終了した |
読み取りはレート制限とサーバーエラーで再試行します。何かを作成する書き込みは再試行しません。
コマンド
アカウント
| コマンド | 内容 |
|---|---|
edge login [--device] | このマシンのブラウザでサインインする(PKCE)。組織を選ぶ。--device は任意の端末のワンタイムコードだが、いまは組織ロールを載せられない |
edge logout | プロファイルの保存済みサインインを削除する |
edge whoami | 組織、ワークスペース、スコープ、トークンの有効期限を表示する |
edge token | 現在の短期アクセストークンを表示する。curl で使う |
edge tokens create | パーソナルアクセストークン を作成する。権限と有効期限を選び、確認してから作成 |
edge tokens ls [--all] | 自分のトークンを一覧する。--all は組織全体(token.admin) |
edge tokens revoke ID | トークンをすぐに取り消す |
edge workspaces ls | 組織のワークスペースを一覧する |
公開
| コマンド | 内容 | 公開中のサイトが変わるか |
|---|---|---|
edge link | このプロジェクトの distribution とフォルダを保存する | いいえ |
edge deploy [DIR] | まとめてアップロードし、commit してプレビューを待つ | いいえ |
edge deploy --promote | 上と同じあと promote する | はい |
edge deployments promote ID | ready の deployment を公開する | はい |
edge deployments promote ID --at TIME | その promote を予約する | はい(TIME に) |
edge deployments rollback | 前の deployment に戻す | はい |
edge distributions takedown ID --gone または --redirect URL | 公開中のホストで 410、または URL への 302 を返す | はい(すぐに、または --at に) |
edge distributions restore ID | 公開停止を解除する | はい(すぐに、または --at に) |
edge redirects import DIST FILE --apply | インポートしたリダイレクトを持つ deployment を作成する | promote するまではいいえ |
edge deploy は DIR を、ファイルがアーカイブのルートに来る bundle.tar.gz にまとめます。 .git、.edge、macOS のメタデータファイルは含めません。
ワークスペース
| コマンド | スコープ |
|---|---|
edge workspaces ls | namespace.read |
Distribution
| コマンド | スコープ |
|---|---|
edge distributions ls | distribution.read |
edge distributions get ID | distribution.read |
edge distributions create --slug SLUG --template T | distribution.write |
edge distributions update ID --config FILE | distribution.write |
edge distributions copy ID --slug NEW | distribution.write |
edge distributions rm ID --confirm-slug SLUG | distribution.destroy |
edge distributions slug-check SLUG | distribution.read |
edge distributions takedown ID (--gone | --redirect URL) [--at TIME] | deployment.promote |
edge distributions restore ID [--at TIME] | deployment.promote |
Deployment
| コマンド | スコープ |
|---|---|
edge deployments ls | deployment.read |
edge deployments get ID | deployment.read |
edge deployments create [--from ID] | deployment.write |
edge deployments check | deployment.write |
edge deployments commit ID | deployment.write |
edge deployments promote ID [--at TIME [--tz ZONE]] | deployment.promote |
edge deployments rollback [--to ID] | deployment.promote |
edge schedules ls DIST [--status S] | deployment.read |
edge schedules cancel SCHEDULE | deployment.promote |
edge deployments diff FROM TO | deployment.read |
edge deploy [DIR] | deployment.write、deployment.read。--promote には deployment.promote も必要 |
edge deployments rollback は、以前の ready な deployment(既定では公開中の deployment のひとつ前)を 新しい deployment として復元し、プレビューを待ってから promote します。--preview-only を付けると promote の前で止まります。
--at はオフセット付きの RFC 3339(2026-11-01T00:00:00+09:00)、または 2026-11-01 00:00 のようなローカル時刻を受け取ります。ローカル時刻は --tz(Asia/Tokyo などの IANA 名)またはコンピューターのタイムゾーンで解釈します。--at を付けると、コマンドは操作を予約して schedule_id を返します。リリースと公開停止を予約する を参照してください。
チェック
| コマンド | スコープ |
|---|---|
edge distributions invalidate ID [--path P] | deployment.promote |
edge distributions redirect-check ID --path P | distribution.read |
edge redirects check DIST PATH [--deployment ID] | distribution.read |
edge redirects import DIST FILE [--format F] [--replace] [--apply] | distribution.write |
edge redirects export DIST [--format F] [--deployment ID] | distribution.read |
edge distributions header-check ID --path P | distribution.read |
edge distributions health ID | analytics.read |
edge redirects import は --apply を付けない限りドライランです。ファイルにエラーがあると、行番号付きで各エラーを一覧したあと、終了コード 6 で終わります。形式は、--format を付けない限りファイルの拡張子で決まります(.csv、.json、それ以外は Netlify の _redirects)。リダイレクト を参照してください。
Webhook とフック
| コマンド | スコープ |
|---|---|
edge webhooks ls | webhook.read |
edge webhooks get ID | webhook.read |
edge webhooks create --url URL --event TYPE | webhook.write。form.* は form.forward と --yes も必要 |
edge webhooks update ID | webhook.write |
edge webhooks rm ID | webhook.write |
edge webhooks test ID | webhook.write |
edge webhooks rotate-secret ID | webhook.write |
edge webhooks deliveries ID | webhook.read |
edge webhooks redeliver ID DELIVERY | webhook.write |
edge hooks ls DISTRIBUTION | hook.read |
edge hooks get DISTRIBUTION HOOK | hook.read |
edge hooks create DISTRIBUTION --slug SLUG --preset PRESET | hook.write |
edge hooks update DISTRIBUTION HOOK | hook.write |
edge hooks rm DISTRIBUTION HOOK | hook.write |
edge hooks receipts DISTRIBUTION HOOK | hook.read |
edge hooks receipt DISTRIBUTION HOOK KEY | hook.read |
edge webhooks は HTTPS エンドポイントを Edge のイベントに購読します。署名用シークレットは一度だけ表示されます。form.* を含む購読は、確認するまで(または --yes を付けるまで)何も作成しません。edge hooks は distribution の /_hooks/{slug} で他サービスの Webhook を受けます。どちらもそれだけでは本番サイトを変えません。フックのアクション promote_latest または invalidate は、distribution が live になったあとで本番サイトを変えます。--config で設定するアクション enqueue、workflow_start、workflow_signal には、queue.send または workflow.write も必要です。wasm は 200 のあと、その distribution の関数ランタイムを 1 つ実行します。必要なのは hook.write と、そこに既にある関数です。
エンドポイント
| コマンド | スコープ |
|---|---|
edge jobs ls DISTRIBUTION [--owner-kind K] [--status S] [--before NEXT] [--limit N] | function.read |
edge jobs ls は バックグラウンドジョブ の実行履歴を新しい順で一覧します。表形式では次のページを取得するコマンドを stderr に表示し、-o json は next_before を含むページ全体を返します。関数ランタイム自体は MCP で管理します。
Cron
| コマンド | スコープ |
|---|---|
edge crons ls DISTRIBUTION | cron.read |
edge crons get CRON | cron.read |
edge crons create DISTRIBUTION --name N --schedule S (--function SCRIPT | --emit | --invalidate PATH | --promote-latest | --enqueue QUEUE | --start-workflow SCRIPT) | cron.write |
edge crons update CRON | cron.write |
edge crons rm CRON | cron.write |
edge crons trigger CRON | cron.write |
edge crons runs CRON [--status S] | cron.read |
edge crons check DISTRIBUTION --schedule S [--tz ZONE] | cron.read |
--tz は Asia/Tokyo のような IANA 名を受け取り、既定は UTC です。cron のターゲットを指定するフラグはちょうど 1 つです。--promote-latest と --invalidate は cron が実行されるたびにライブサイトを変えます。edge crons update は指定したフラグだけを送り、--enabled false で cron を一時停止します。
キュー
| コマンド | スコープ |
|---|---|
edge queues ls DISTRIBUTION | queue.read |
edge queues get QUEUE | queue.read |
edge queues create DISTRIBUTION --name N (--function SCRIPT | --webhook URL) | queue.write |
edge queues update QUEUE | queue.write |
edge queues rm QUEUE | queue.write |
edge queues send QUEUE (--body JSON | --file FILE) | queue.send |
edge queues peek QUEUE [--status ready|leased|dead] [--bodies] | queue.read |
edge queues purge QUEUE --status ready|dead | queue.write |
edge queues redrive QUEUE [--message ID] | queue.write |
edge queues stats QUEUE | queue.read |
edge queues runs QUEUE [--status S] | queue.read |
create と update は --batch-size、--batch-wait、--concurrency、--max-attempts、--retention-days、--senders を受け取ります。update は指定したフラグだけを送り、--paused true でキューを一時停止します。send --file は JSON Lines を読み、1 行に 1 つの {"body": …, "delay_seconds"?, "idempotency_key"?}(- で標準入力)を 100 件ずつ送ります。purge と rm は --yes がなければ削除の前に確認します。
ワークフロー
| コマンド | スコープ |
|---|---|
edge workflows start DISTRIBUTION --function SCRIPT [--input JSON] [--name N] [--key K] | workflow.write |
edge workflows ls DISTRIBUTION [--status S] | workflow.read |
edge workflows get RUN | workflow.read |
edge workflows signal RUN --name SIGNAL [--payload JSON] [--key K] | workflow.write |
edge workflows cancel RUN | workflow.write |
edge workflows retry RUN | workflow.write |
表形式では get が実行のステップを表示し、-o json は実行全体を返します。cancel は --yes がなければキャンセルの前に確認します。
アクセス
| コマンド | スコープ |
|---|---|
edge access show DISTRIBUTION | distribution.read |
edge access rules ls DISTRIBUTION | access.read |
edge access rules add DISTRIBUTION --kind KIND | access.write |
edge access rules rm RULE_ID | access.write |
edge access check DISTRIBUTION | access.read |
edge access revocations ls DISTRIBUTION | access.read |
edge access sessions revoke DISTRIBUTION | access.write |
edge access network ls [DISTRIBUTION] | access.read |
edge access network add (DISTRIBUTION | --all-sites) VALUE... | access.write |
edge access network rm RULE_ID | access.write |
edge access network check DISTRIBUTION [IP] | access.read |
edge access network mode DISTRIBUTION (enforce | login-fallback) | access.write |
edge access network ip | なし |
--all は全員をサインアウトします。edge access network add は既定で許可します。--block でブロック、--country で値を国コードとして扱い、--mine でこのマシンのアドレスを追加します。edge access network ip と、IP を省いた check は https://ip.edge.deca-dev.com/ を読みます。アクセス制御 を参照してください。
パーソナルアクセストークン
| コマンド | スコープ |
|---|---|
edge tokens ls | サインイン済み。--all は token.admin が必要 |
edge tokens create | サインイン済み。パーソナルアクセストークンでは不可 |
edge tokens revoke ID | サインイン済み。他人のトークンは token.admin が必要 |
データオブジェクト、キーバリューと SQL、ドメイン、アナリティクスとログ、ゴール、アナリティクスのグループとファネル、 プロパティと PII、エンドポイントにはまだ専用コマンドがありません。それまでは edge api で HTTP API のルートを呼んでください。トークンは自動で付きます。スコープは呼ぶルートの スコープ です。
edge api GET /v1/slugs/acme-marketing
edge api GET /v1/domains
edge api POST /v1/analytics --input query.json関数ランタイム、データオブジェクトの履歴、グラント、プライベートデータオブジェクトにはまだ HTTP ルートが ないため、CLI では管理できません。これらにはエージェントを使ってください。
ユーティリティ
| コマンド | 内容 |
|---|---|
edge commands | すべてのコマンドとフラグ、スコープを一覧する(プログラム向けは -o json) |
edge completion bash|zsh|fish|powershell | シェル補完スクリプトを出力する |
edge version | バージョンを表示する |
edge upgrade | 新しいリリースを確認し、インストールするコマンドを表示する |