コンテンツにスキップ

CLI リファレンス

awnexa [グローバルオプション] <コマンド> [オプション]

すべてのコマンドは JSON を stdout に出力し、ログとエラーは stderr に出力します。awnexa <コマンド> --help で、インストールしたバージョンについて同じ情報を確認できます。

目次: グローバルオプション · セットアップとスキャン · 検索・参照 · スナップショットと差分 · 設計書とエクスポート · Claude Code · 情報 · 利用統計 · MCP のツール · 設定ファイル · 環境変数 · 終了コード

共通の決まり:

  • <ref> はリソースの uid・ARN・リソース ID(例: sg-0123456789abcdef0)・名前です。複数のリソースが同じ名前のとき、graph・impact・overview --entry は AMBIGUOUS_REF と候補を返して止まり、resources show はすべてを表示します。見つからないときは、検索で近いものをエラーの candidates に挙げます。
  • --scan <id> はスキャン ID か latest を指定します。省略すると最新の終了したスキャンを使います。
  • 複数の値を取るオプション(--region・--type・--service・--status など)は、カンマ区切りでも、繰り返しても指定できます。
  • 長い結果は --limit と --offset でページを分けます。出力の pagination.nextOffset が次の --offset です。

コマンド名の前に付けます(例: awnexa --data-dir ~/awnexa/prod status)。

オプション 説明
--data-dir <dir> データディレクトリ。既定は $AWNEXA_HOME、最も近い ./.awnexa(ここか親ディレクトリ)、~/.awnexa
--format <format> json(既定)か table。table は一覧系のコマンドで使えます(ほかは stderr に警告を出して JSON を出力)
--compact JSON を 1 行で出力する
--no-legend legend / itemLegend / metricsLegend を省く(どの応答でも同じ文。一度読めば十分)
--log-level <level> stderr のログレベル: silent・fatal・error・warn(既定)・info・debug・trace
-V, --version バージョン番号を表示する
-h, --help ヘルプを表示する(awnexa help <コマンド> も可)

データディレクトリ(既定は ./.awnexa)と、設定ファイル・データベースを作ります。

オプション 説明
--profile <name> 既定の AWS プロファイル(名前だけを保存し、認証情報は保存しない)
-r, --region <regions> 既定のリージョン
--force 既存の設定ファイルを上書きする
--sample 架空のシステムの 2 回分のスキャンを入れた別のデータディレクトリ(既定は ./.awnexa-sample。AWNEXA_HOME は使わない)を作る。AWS アカウントなしで試せる。AWS は呼ばず、認証情報も使わない

--profile や --region を付けてもう一度 init を実行すると、その設定だけを書き換え、ほかの設定は残します。出力には次に実行するコマンド(next)が入り、既定のリージョンが保存も設定もされていないときは warning が付きます。

--sample で作ったデータの出力には sample: true と sampleWarning が付きます。ほかのコマンドで読むときは --data-dir ./.awnexa-sample を付けてください。実際のアカウントは別のデータディレクトリにスキャンします。

読み取り専用のスキャン(Describe* / List* / Get* / BatchGet* / Search* の API だけ)を実行し、新しいスナップショットを保存します。終了コード 0 はすべて取得できたこと、4 は一部の Coverage が partial または failed であることを示します(読み取れた分は保存されます)。30 秒より長くかかるスキャンは、30 秒ごとに stderr に {"progress":{...}} の行(完了した API の取得単位の数と全体の数、それまでのリソース数)を出します。--log-level error で出さなくなります。

オプション 説明
--profile <name> AWS プロファイル。認証情報は AWS SDK の既定のチェーンで解決します
-r, --region <regions> スキャンするリージョン
--all-regions アカウントで有効なすべてのリージョンをスキャンする
-s, --services <ids> これらのサービスプラグインだけ(ID は awnexa plugins)。既定はすべて
--concurrency <n> API の一覧取得の最大並列数
--no-evidence API の生のレスポンス(機密値はマスキング済み)をディスクに書かない
--metrics EC2・NAT ゲートウェイ・RDS・Lambda・SQS・SNS・ロードバランサー・API Gateway・DynamoDB・ECS・S3・CloudFront の利用状況のメトリクス(直近 14 日の日ごとの値)も取得する(CloudWatch GetMetricData。メトリクスごとに課金。cloudwatch:GetMetricData が必要)

データディレクトリ、データベースの統計、最新のスキャン。より新しいスキャンが失敗・実行中のときは、出力に warning が付きます。実行中のまま 60 分進捗がないスキャンは強制終了された可能性が高く、possiblyStopped が付きます。scan.ageHours は最新のスキャンが完了してからの時間で、7 日以上たつと staleWarning が付きます(resources list・overview などの問い合わせのコマンドにも付きます)。最初のスキャンの前は、hint が awnexa scan の実行を案内します。カレントディレクトリに古い Awnexa がインストールした Skill があるときは、skillsOutdated がその名前を示します。

サービス・リージョン・API ごとに、何を取得でき、何を取得できなかったか。

オプション 説明
--scan <id> スキャン ID か latest
--status <statuses> 絞り込み: complete・partial・unsupported・access_denied・failed・not_applicable・skipped・unknown
-r, --region <regions> リージョン
-s, --service <services> サービスの名前空間(例: ec2)またはプラグイン ID(例: ec2-network)

スキャンのリソースの一覧。指定しない限りプロパティは省きます。項目は簡潔な形で、ARN は uid と異なるときだけ、アカウントはスキャンのアカウントと異なるときだけ、取得状態と確度は complete / direct でないときだけ含めます。結果が 0 件、または一覧が不完全かもしれないときは、resultCoverage が理由を示します(スキャンに無い条件の値と didYouMean、スキャンで読んでいない型・サービス・リージョン、ほかのリージョンでだけ読んだ型、完了していない一覧取得の API)。

オプション 説明
--scan <id> スキャン ID か latest
-t, --type <types> リソース型(例: AWS::EC2::VPC)
-s, --service <services> サービスの名前空間(例: ec2)、または awnexa plugins のプラグイン ID(例: ec2-network。そのプラグインが集める型)
-r, --region <regions> リージョン。グローバルなサービス(IAM・CloudFront など)は global
--account <id> 所有者のアカウント ID
--parent <uid> 親リソースの uid・ID・名前(例: VPC のサブネット)
--tag <key[=value]> タグのキー、またはキーと値
--name <text> 名前の一部
--properties すべてのプロパティを含める
--fields <paths> これらのプロパティのパスだけ(例: PubliclyAccessible,MasterUserSecret.SecretArn)
--where <condition> プロパティが Path=value または Path!=value に合うリソースだけ(繰り返すと AND。配列はたどる)。出力の where は、パスが無いため除いたリソース(pathMissing・unretrieved)を数える。その値は不明
--metrics 利用状況のメトリクスの要約を付ける(scan --metrics で取得したスキャン)
--provenance サービス・ARN・アカウント・取得元を含む完全な項目にする(既定は簡潔な項目)
--limit <n> ページサイズ、1〜1000(既定 50)
--offset <n> ページの開始位置(既定 0)

1 つのリソースを、プロパティ・関係性・利用状況のメトリクス付きで表示します。--fields を指定したときは、--relationships か --metrics を付けない限り関係性とメトリクスを省きます(出力の omitted に挙げます)。

オプション 説明
--scan <id> スキャン ID か latest
--relationships 関係性を含める(--fields を指定しないときの既定)
--no-relationships 関係性を省く
--metrics 利用状況のメトリクスを含める(--fields を指定しないときの既定)
--no-metrics 利用状況のメトリクスを省く
--fields <paths> これらのプロパティのパスだけ(ドット区切り、大文字小文字を区別しない)
--outline プロパティのキーと短い値だけを表示し、大きな値は要約する
--full 大きなプロパティもすべて表示する(既定では大きなプロパティは要約する)

uid・ARN・ID・名前・型・タグの全文検索(前方一致)。よく合うものから順に並べます。結果が 0 件や不足しているときの resultCoverage は resources list と同じです。

オプション 説明
--scan <id> スキャン ID か latest
-t, --type <types> これらのリソース型だけ
-r, --region <regions> これらのリージョンだけ(グローバルなサービスは global)
--provenance 完全な項目にする(resources list と同じ)
--limit <n> ページサイズ、1〜1000(既定 20)
--offset <n> ページの開始位置(既定 0)

スキャンの関係性。1 つのリソースの周りに絞り込めます。

オプション 説明
--scan <id> スキャン ID か latest
--resource <ref> このリソースの関係性だけ
--direction <dir> out・in・both(既定)
--type <types> network・traffic・security・data・deployment・monitoring・event・association・dependency
--target-status <s> resolved・unresolved・external
--limit <n> ページサイズ、1〜1000(既定 100)
--offset <n> ページの開始位置(既定 0)

関係グラフでのリソースの周辺。

オプション 説明
--scan <id> スキャン ID か latest
--depth <n> ホップ数、1〜5(既定 1)
--max-nodes <n> ノードの上限、1〜2000(既定 200)
--direction <dir> out・in・both(既定)
--type <types> 関係性の種類
--as <format> json(既定)か mermaid(Mermaid のフローチャート)

リソースを変更・削除したときに影響を受けるもの。そのリソースを直接・間接に参照しているものを、理由となる経路と Coverage の注意付きで返します。

オプション 説明
--scan <id> スキャン ID か latest
--depth <n> ホップ数、1〜8(既定 3)
--max-nodes <n> 結果の上限、1〜2000(既定 200)
--type <types> たどる関係性の種類
--min-confidence <c> たどる関係性の最も弱い確度: direct・derived・inferred(既定)
--as <format> json(既定)か mermaid

システムの概要。すべての入口(ロードバランサー・CloudFront・API・関数 URL)と、そのリクエストが届くルーティング・コンピューティング・データストア、経路の欠け、Coverage の注意を返します。

オプション 説明
--scan <id> スキャン ID か latest
-r, --region <regions> 入口のリージョン。CloudFront は global
--entry <ref> 1 つの入口だけを、すべてのリソースと関係性をたどって表示する
--max-paths <n> 展開する入口の数、1〜500(既定 50)
--max-nodes <n> 経路ごとのリソース数、1〜2000(既定 200)
--group-by <by> stack(CloudFormation / AppRegistry。既定)・tag:<key>・none
--max-groups <n> 表示するグループ数、1〜500(既定 50)

スキャンの一覧(新しい順)。

オプション 説明
--account <id> このアカウントだけ
--limit <n> ページサイズ、1〜1000(既定 20)
--offset <n> ページの開始位置(既定 0)

1 つのスキャンの詳細なメタデータ(SDK のバージョン、オプション、Coverage、エラーの概要)。

awnexa snapshot diff [baseScanId] [targetScanId]

Section titled “awnexa snapshot diff [baseScanId] [targetScanId]”

同じアカウントの 2 つのスキャンを比較します。スキャン ID を省くと、最新の終了したスキャン(latest)と、同じアカウントのその前の終了したスキャン(previous)を比べます。どちらもスキャン ID で指定できます。見つからないリソースを削除・作成とするのは、両方のスキャンで一覧取得の API が完了したときだけで、それ以外は unknown です。無料版で比較できるのは、アカウントごとに最新 3 世代のスキャンです。

オプション 説明
--change <types> created・modified・deleted・unchanged・unknown
-t, --type <types> リソース型
--include-unchanged 変わっていないリソースも表示する
--no-persist 計算した変更をデータベースに保存しない
--limit <n> ページサイズ、1〜1000(既定 200)
--offset <n> ページの開始位置(既定 0)
--as <format> json(既定)か markdown(人向けのレポート。絞り込みは効き、ページ分けはしない)
--max-property-changes <n> markdown: 変更されたリソースごとに表示するプロパティの変更数、1〜1000(既定 20)
--lang <lang> markdown: en か ja(既定は config.json の reportLang、無ければ en)

古いスキャンを、取得根拠のファイルと一緒にデータディレクトリから削除します。元に戻せません。各アカウントの最新の完了(または一部取得)したスキャンと、実行中(24 時間未満)のスキャンは必ず残ります。--yes が無いときは確認を求めます。

オプション 説明
--keep <n> 各アカウントの最新 N 件を残す
--older-than <age> これより前に開始したスキャンだけ(30d・12h・2w か ISO 形式の日付)
--scan <ids> これらのスキャン ID だけ(最新のスキャンの保護も外れる)
--status <statuses> これらのステータスのスキャンだけ: running・completed・partial・failed・aborted
--account <id> このアカウントのスキャンだけ
--dry-run 削除せず、削除されるものを表示する
-y, --yes 確認しない
--vacuum 削除後にデータベースファイルを圧縮する

Mermaid の図を含む Markdown の設計書。--out にファイルを書き出すか、1 つの --doc を stdout に出力します。設計書(と snapshot diff --as markdown の Markdown)は英語で、--lang ja(または config.json の "reportLang": "ja")で日本語で書かれます。

オプション 説明
--scan <id> スキャン ID か latest
-o, --out <dir> 出力先ディレクトリ(README.md・network.md・security.md・inventory.md・coverage.md)
--doc <names> 生成する文書: overview・network・security・inventory・coverage
-r, --region <regions> これらのリージョンだけ
--max-diagram-nodes <n> 図ごとのノードの上限、1〜2000(既定 120)
--max-inventory-rows <n> inventory.md のリソース型ごとの行数、1〜100000(既定 300)
--lang <lang> en か ja(既定は config.json の reportLang、無ければ en)

スキャン全体(ヘッダー・Coverage・リソース・関係性・利用状況のメトリクスと、それらの根拠の Evidence)を JSON か NDJSON で出力します。

オプション 説明
--scan <id> スキャン ID か latest
--as <format> json(既定)か ndjson
-o, --out <path> 出力ファイル(--split のときはディレクトリ)。既定は stdout
--split --out のディレクトリに、サービスごとのファイルと _index.json を書く
-s, --service <services> これらのサービスの名前空間(ec2)またはプラグイン ID(ec2-network)だけ
-r, --region <regions> これらのリージョンだけ(グローバルなサービスは global)
-t, --type <types> これらのリソース型だけ
--no-properties リソースのプロパティを省く

ローカルのデータベースを読む、読み取り専用のツールを持つ MCP(Model Context Protocol)サーバーを stdio で起動します。AWS は呼び出しません。claude mcp add awnexa -- awnexa mcp で登録します。MCP のツールを参照してください。

Awnexa に同梱の Claude Code Skill の一覧と、それぞれがプロジェクトにインストールされているか(installed: current、outdated(古い Awnexa がインストールしたもの)、modified(このバージョンがインストールした後に編集したもの)、not_installed)。

オプション 説明
--project <dir> 確認するプロジェクト(既定は .)

同梱の Skill を <project>/.claude/skills にコピーします。

オプション 説明
--project <dir> コピー先のプロジェクト(既定は .)
--name <names> これらの Skill だけ
--force すでにある Skill を上書きする

すでにある Skill はコピーしません。そのうち古い Awnexa がインストールしたものは outdated にも入るので、--force で更新します(その Skill へのローカルの編集は置き換わります)。コピーしたときは、Skill が Awnexa の MCP サーバーを登録していればそれを通して読むことを note で知らせます。

コマンド 説明
awnexa version Awnexa・データスキーマ・AWS SDK のパッケージ・Node.js のバージョン
awnexa plugins サービスプラグインと、それぞれが呼び出す読み取り専用の API と IAM のアクション(requiredIamActions)
awnexa catalog 実装済み・予定の API。オプション: --status implemented|planned、--service <service>

匿名の利用統計は既定でオンで、AWS の構成データは含みません。CLI が送信するデータを参照してください。

コマンド 説明
awnexa telemetry status 利用統計を送るかどうかと、その理由(環境変数・設定・既定)
awnexa telemetry disable 送信をやめ、インストール ID と未送信のイベントを削除する
awnexa telemetry enable 再び送信する(新しいインストール ID で)
awnexa telemetry show 未送信のイベントと直近に送った 10 件を、送る内容そのままで表示する

awnexa mcp が提供する読み取り専用のツールです。パラメータは対応するコマンドのオプションに合わせてあります。

ツール 対応するコマンド
awnexa_status status
awnexa_coverage coverage
awnexa_resources_list resources list
awnexa_resources_show resources show
awnexa_search search
awnexa_relationships_list relationships list
awnexa_graph graph
awnexa_impact impact
awnexa_overview overview
awnexa_snapshot_list snapshot list
awnexa_snapshot_diff snapshot diff
awnexa_diff_report snapshot diff --as markdown
awnexa_report report --doc …

スキャン・削除(prune)・エクスポートは MCP からは使えません。Claude Code はスキャン済みの結果を読み、スキャンするタイミングは利用者が決めます。

awnexa init はデータディレクトリに config.json を作成します。コマンドラインのオプションが優先されます。 AWS の認証情報はここに保存しません。プロキシの設定を含むすべてのキーは設定ファイルを参照してください。

変数 説明
AWNEXA_HOME データディレクトリ(--data-dir が無いとき)
AWNEXA_TELEMETRY 0・off・false で利用統計を無効にする。debug は送信せずにイベントを表示する
DO_NOT_TRACK 1 で利用統計を無効にする
HTTPS_PROXY・HTTP_PROXY・NO_PROXY network.proxy / network.noProxy が無いときのプロキシ(設定ファイル)
AWS_CA_BUNDLE network.caBundle が無いときに追加で信頼する CA 証明書
AWS_PROFILE・AWS_REGION など AWS SDK の環境変数 --profile / --region と設定ファイルで指定が無いとき、AWS CLI と同じように使われる
コード 意味
0 成功
1 エラー
2 引数の誤り、または確認が必要だった
3 AWS の認証に失敗した(AWS_AUTH_FAILED)
4 scan は終わったが、一部の Coverage が partial または failed
130 強制終了(Ctrl+C を 2 回押した)
143 強制終了(SIGTERM を受けてから 10 秒後)

エラーは stderr に {"error":{"code":"…","message":"…"}} の形で出力します。スキャン中に Ctrl+C を 1 回押す(または SIGTERM を送る)と、実行中の API 呼び出しを終えてからスキャンを aborted にします。