Skip to content

CLI ​

edge は HTTP API のクライアントです。各コマンドは https://api.edge.deca-dev.com 向けの トークンで /v1 を呼び、そのコマンドに示された スコープ を必要とします。 インストールは CLI をインストールする を参照してください。

グローバルフラグ ​

フラグ意味
--profile NAME使うプロファイル(API ホストとサインイン)。省略時は有効なプロファイル
--workspace ID_OR_SLUG操作するワークスペース。省略時は組織の default ワークスペース
-o, --output FORMATtable、json、jsonl、tsv。出力 を参照
--fields a,b,c各結果のうち指定したフィールドだけを残す
--jq EXPRjq 式で JSON の結果を絞り込む。jq を別途インストールする必要はない
--raw--jq と併用し、文字列を引用符なしで出力する
--prettyJSON をインデントする
--limit N一覧から最大 N 件を返す
--allページングを最後までたどる
--yes対話的な確認プロンプトを省略する
--dry-run送信するリクエストを表示して終了する。何も変更しない
--no-color装飾なしで出力する。NO_COLOR=1 でも同じ
--debugリクエストとレスポンスを標準エラー出力に記録する(トークンは伏せる)

組織は常にトークンから決まります。--organization フラグはありません。

プロファイル ​

プロファイルは接続設定のまとまりで、呼び出す API ホストと使うサインインを決めます。 この環境の組み込みプロファイル名は edge.deca-dev.com です。

bash
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_SECRETCI 用のマシン認証情報。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読みやすく桁をそろえた表。端末での既定
jsonAPI のレスポンスそのまま。パイプやリダイレクト時の既定
jsonl1 行に 1 つの JSON オブジェクト。パイプ時の logs tail などストリームの既定
tsv見出し行のあとに、1 件ごとのタブ区切りの行

JSON 出力は API のレスポンス本文で、名前の変更はしません。そのため HTTP API とこのページは 同じフィールドを説明しています。

進捗メッセージ、プロンプト、エラーは標準エラー出力に出ます。標準出力には結果だけが出ます。

json モードのエラーは、API の エラー形式 に HTTP ステータスと対処のヒントを加えたものです。

json
{"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 IDready の 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 lsnamespace.read

Distribution ​

コマンドスコープ
edge distributions lsdistribution.read
edge distributions get IDdistribution.read
edge distributions create --slug SLUG --template Tdistribution.write
edge distributions update ID --config FILEdistribution.write
edge distributions copy ID --slug NEWdistribution.write
edge distributions rm ID --confirm-slug SLUGdistribution.destroy
edge distributions slug-check SLUGdistribution.read
edge distributions takedown ID (--gone | --redirect URL) [--at TIME]deployment.promote
edge distributions restore ID [--at TIME]deployment.promote

Deployment ​

コマンドスコープ
edge deployments lsdeployment.read
edge deployments get IDdeployment.read
edge deployments create [--from ID]deployment.write
edge deployments checkdeployment.write
edge deployments commit IDdeployment.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 SCHEDULEdeployment.promote
edge deployments diff FROM TOdeployment.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 Pdistribution.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 Pdistribution.read
edge distributions health IDanalytics.read

edge redirects import は --apply を付けない限りドライランです。ファイルにエラーがあると、行番号付きで各エラーを一覧したあと、終了コード 6 で終わります。形式は、--format を付けない限りファイルの拡張子で決まります(.csv、.json、それ以外は Netlify の _redirects)。リダイレクト を参照してください。

Webhook とフック ​

コマンドスコープ
edge webhooks lswebhook.read
edge webhooks get IDwebhook.read
edge webhooks create --url URL --event TYPEwebhook.write。form.* は form.forward と --yes も必要
edge webhooks update IDwebhook.write
edge webhooks rm IDwebhook.write
edge webhooks test IDwebhook.write
edge webhooks rotate-secret IDwebhook.write
edge webhooks deliveries IDwebhook.read
edge webhooks redeliver ID DELIVERYwebhook.write
edge hooks ls DISTRIBUTIONhook.read
edge hooks get DISTRIBUTION HOOKhook.read
edge hooks create DISTRIBUTION --slug SLUG --preset PRESEThook.write
edge hooks update DISTRIBUTION HOOKhook.write
edge hooks rm DISTRIBUTION HOOKhook.write
edge hooks receipts DISTRIBUTION HOOKhook.read
edge hooks receipt DISTRIBUTION HOOK KEYhook.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 DISTRIBUTIONcron.read
edge crons get CRONcron.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 CRONcron.write
edge crons rm CRONcron.write
edge crons trigger CRONcron.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 DISTRIBUTIONqueue.read
edge queues get QUEUEqueue.read
edge queues create DISTRIBUTION --name N (--function SCRIPT | --webhook URL)queue.write
edge queues update QUEUEqueue.write
edge queues rm QUEUEqueue.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|deadqueue.write
edge queues redrive QUEUE [--message ID]queue.write
edge queues stats QUEUEqueue.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 RUNworkflow.read
edge workflows signal RUN --name SIGNAL [--payload JSON] [--key K]workflow.write
edge workflows cancel RUNworkflow.write
edge workflows retry RUNworkflow.write

表形式では get が実行のステップを表示し、-o json は実行全体を返します。cancel は --yes がなければキャンセルの前に確認します。

アクセス ​

コマンドスコープ
edge access show DISTRIBUTIONdistribution.read
edge access rules ls DISTRIBUTIONaccess.read
edge access rules add DISTRIBUTION --kind KINDaccess.write
edge access rules rm RULE_IDaccess.write
edge access check DISTRIBUTIONaccess.read
edge access revocations ls DISTRIBUTIONaccess.read
edge access sessions revoke DISTRIBUTIONaccess.write
edge access network ls [DISTRIBUTION]access.read
edge access network add (DISTRIBUTION | --all-sites) VALUE...access.write
edge access network rm RULE_IDaccess.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 のルートを呼んでください。トークンは自動で付きます。スコープは呼ぶルートの スコープ です。

bash
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新しいリリースを確認し、インストールするコマンドを表示する

あわせて読む ​