cargo-vet ガイドコマンド
コマンド
この節では、cargo vet のコマンドラインインターフェースを説明します。この
ドキュメントは実装から自動的に生成されているので、コードがまだ開発中の部分では
不完全なことがあります。
使い方
cargo vet [OPTIONS]
cargo vet <COMMAND>
コマンド
- check: [既定] 現在のプロジェクトが検証済みであることを確認します
- suggest: 手軽にレビューできるものを提案します
- init: プロジェクトで cargo-vet を使えるように初期化します
- inspect: パッケージのソースを取得します
- diff: 最後にレビューしたバージョンとの差分を出力します
- certify: パッケージを監査済みとして記録します
- import: 新しいピアのインポートを取り込みます
- trust: 指定したクレートと公開者を信頼します
- regenerate: さまざまな情報を明示的に再生成します
- add-exemption: パッケージをレビューの免除対象として記録します
- record-violation: パッケージの一部のバージョンが特定の監査基準に違反していることを宣言します
- fmt: vet のすべてのファイルを整形し直します(手で編集した場合のため)
- prune: 不要なインポートと免除を刈り込みます
- aggregate: 複数の取得元から監査を取得し、1 つの
audits.tomlファイルにまとめます - explain-audit: 指定した基準でパッケージを認定するために cargo-vet が算出した監査の経路を表示します
- dump-graph:
cargo vetが把握している cargo のビルドグラフを表示します - gc: vet のキャッシュから古いパッケージを片づけます
- renew: ワイルドカード監査の有効期限を更新します
オプション
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
-V, --version
バージョンを表示します
グローバルオプション
--manifest-path <PATH>
Cargo.toml へのパス
--store-path <STORE_PATH>
supply-chain ディレクトリへのパス
--no-all-features
–all-features を使いません
依存ツリーの全体を分析したいので、既定では cargo metadata に –all-features を渡します
--no-default-features
default フィーチャーを有効にしません
--features <FEATURES>
有効にするフィーチャーの、空白区切りのリスト
--locked
インポートする監査を新しく取得しません
--frozen
ネットワークをいっさい使いません。cargo のキャッシュがすでに用意されているか、依存がベンダーされている必要があります。–locked が必要です
--use-git-credentials
リモートの資源をダウンロードするときの認証に、git の認証情報ヘルパーを使います。これにより、システムの認証情報ストアと連携できます
--no-minimize-exemptions
check や certify などのコマンドが、使われていない免除を自動的に片づけないようにします
--no-registry-suggestions
check や suggest などのコマンドが、レジストリからのインポートを提案しないようにします
--verbose <VERBOSE>
ログをどの程度詳しく出すか(ログレベル)
[default: warn]
[possible values: off, error, warn, info, debug, trace]
--output-file <OUTPUT_FILE>
出力を、標準出力の代わりにこのファイルへ書き込みます
--log-file <LOG_FILE>
ログを、標準エラー出力の代わりにこのファイルへ書き込みます(CLI の解析に成功した後にだけ使われます)
--output-format <OUTPUT_FORMAT>
出力の形式
[default: human]
指定できる値:
- human: 人が読みやすい形式で出力します
- json: 機械が読み取れる形式で、余分な文脈を最小限にして出力します
--cache-dir <CACHE_DIR>
全体共通のキャッシュディレクトリの代わりに、指定したパスを使います
キャッシュには、vet の提案の仕組みが使う要約結果、crates.io の API から得た結果のキャッシュ、場合によっては crates.io から取得したクレートのチェックアウトなどの情報が保存されます。通常は、システムのキャッシュディレクトリの中で自動的に管理されます。
これは主に、vet 自体をテストするために用意されています。
--filter-graph <FILTER_GRAPH>
ビルドグラフのさまざまな部分を取り除き、それが本当のグラフであるかのように扱います
例: --filter-graph="exclude(any(eq(is_dev_only(true)),eq(name(serde_derive))))"
これは主に、cargo-vet が正しく扱えていないプロジェクトをデバッグしたり、小さくしたりするために用意されています。
これを cargo vet --output-format=json dump-graph と組み合わせると、
vet のテストスイートに追加できる入力を作れます。
結果のグラフは、次のように計算されます。
- まず、元のグラフを計算します
- 次に、フィルターを適用して、新しいノードの集合を求めます
- 新しい空のグラフを作ります
- まだ残っているワークスペースの各メンバーについて、そのメンバーと依存を再帰的に追加します
つまり、ワークスペース外のパッケージがフィルターによって「孤立」した場合、 そのパッケージはフィルターを通過していても暗黙のうちに捨てられます。
指定できるフィルター:
include($query): このフィルターに一致するパッケージだけを含めますexclude($query): このフィルターに一致するパッケージを除外します
指定できるクエリー:
any($query1, $query2, ...): 挙げたクエリーのいずれかが真であれば真all($query1, $query2, ...): 挙げたクエリーのすべてが真であれば真not($query): クエリーが偽であれば真$property: パッケージがこのプロパティを持っていれば真
指定できるプロパティ:
name($string): パッケージの名前(例:serde)version($version): パッケージのバージョン(例:1.2.0)is_root($bool): 元のグラフでルートかどうか(dev-deps は無視します)is_workspace_member($bool): パッケージがワークスペースのメンバーかどうか(テスト可能)is_third_party($bool): vet がそのパッケージをサードパーティとみなすかどうかis_dev_only($bool): 元のグラフで、dev(テスト)ビルドからだけ使われているかどうか
--cargo-arg <CARGO_ARG>
cargo にそのまま渡す引数。複数の引数を渡すために、複数回指定できます。
例: --cargo-arg=-Zbindeps
これにより、プロジェクトの Cargo.toml が必要とする場合に、Cargo の不安定なオプションを使えます。
cargo vet check
[既定] 現在のプロジェクトが検証済みであることを確認します
サブコマンドを指定しなかった場合の、既定の動作です。
監査が足りないためにチェックが失敗した場合は、検証がなぜ失敗したのか、直すには何をすればよいのかを、できるかぎり説明します。考えられる解決策はたくさんあり、話を単純にするために「最善」のものだけをおすすめしたいので、これにはある程度の推測が伴います。
失敗と提案には、「確実(Certain)」なものと「推測(Speculative)」のものがあります。Speculative の項目は灰色で表示され、下のほうに並べられます。これは、Certain の項目を先に見るべきだということを示しています。Speculative の項目は、おそらく同じように監査が必要なものの、Certain の項目の推移的な依存としてしか現れないパッケージに対するものです。
Certain の問題をレビューしている間に、Speculative の項目に必要なことが変わるような対応を取る場合があります。たとえば、必要のないフィーチャーを有効にしていて、Speculative のパッケージがツリーに入っている理由がそれだけだった、と気づくかもしれません。あるいは、Certain のパッケージは safe-to-run でありさえすればよい、と判断するかもしれません。その場合、Speculative の要件が弱まったり、完全に解消されたりすることがあります。こうした理由から、問題は「上から順に」直すことをおすすめします。そして、Certain の項目こそがその「上」です。
提案される修正は、どの基準でレビューすべきかによってまとめられ、レビューのしやすさ(コードの行数で見たもの)の順に並べられます。提案するのは監査だけですが(そのために実行するコマンドも示します)、exemption や policy の変更のように、ほかの直し方もあります。
最も思い切った解決策は、cargo vet regenerate exemptions を実行することです。これは、check を通すのに必要な免除を何でも追加します(そして不要なものを削除します)。理想を言えば、これは避けて監査を追加するほうを選ぶべきですが、予定していた監査をすべて終えたのであれば、これが作業を締めくくる方法です。
使い方
cargo vet check [OPTIONS]
オプション
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet suggest
手軽にレビューできるものを提案します
これは基本的に check と同じですが、「レビューの積み残し」を調べる手段として、すべての exemptions を一時的に取り除いた状態で実行します。そのため、check が失敗している間にこのコマンドを実行することはおすすめしません。得られる情報の質が下がるだけだからです。
ある免除を「積み残し」とは考えていない場合は、そのエントリに suggest = false を追加してください。そうすれば、提案の際にその免除は取り除かれません。
regenerate exemptions も参照してください。これを使うと、積み残しを「ガベージコレクション」できます(check が通っている間に実行した場合)。
使い方
cargo vet suggest [OPTIONS]
オプション
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet init
プロジェクトで cargo-vet を使えるように初期化します
必要とするすべてのパッケージに exemptions と audit-as-crates-io = false を追加します。これにより、check がすぐに通るようになり、プロジェクトで vet を使い始めやすくなります。
この時点で、プロジェクトの設定をさらに進めることも、suggest を使ってレビューの積み残しに取りかかることもできます。
使い方
cargo vet init [OPTIONS]
オプション
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet inspect
パッケージのソースを取得します
現在の check/suggest の状態をもとに、そのパッケージをどの基準で監査したいのかを推測し、その基準の意味をあらかじめ表示します。
使い方
cargo vet inspect [OPTIONS] <PACKAGE> <VERSION>
引数
<PACKAGE>
調べるパッケージ
<VERSION>
調べるバージョン
オプション
--mode <MODE>
ソースをどのように調べるか
local、diff.rs、crates.io、custom_url=URL のいずれかを指定できます。URL は
テンプレートとして扱われ、次の部分文字列が置き換えられます。
{package}: クレートの名前{version}: クレートのバージョン
既定値は、最後に使った –mode 引数の値です。mode 引数を一度も使っていない場合は crates.io になります。
git のバージョンが渡された場合、このオプションは無視され、local が使われます。
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet diff
最後にレビューしたバージョンとの差分を出力します
現在の check/suggest の状態をもとに、そのパッケージをどの基準で監査したいのかを推測し、その基準の意味をあらかじめ表示します。
使い方
cargo vet diff [OPTIONS] <PACKAGE> <VERSION1> <VERSION2>
引数
<PACKAGE>
差分を取るパッケージ
<VERSION1>
差分の基準となるバージョン
<VERSION2>
差分の対象となるバージョン
オプション
--mode <MODE>
差分をどのように調べるか
local、diff.rs、custom_url=URL のいずれかを指定できます。URL は
テンプレートとして扱われ、次の部分文字列が置き換えられます。
{package}: クレートの名前{version1}: クレートの、基準となるバージョン{version2}: クレートの、対象となるバージョン
既定値は、最後に使った –mode 引数の値です。mode 引数を一度も使っていない場合は diff.rs になります。
git のバージョンが渡された場合、このオプションは無視され、local が使われます。
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet certify
パッケージを監査済みとして記録します
このコマンドは、何を認定したいのかをできるかぎり推測します。
引数なしで実行すると、最後に inspect か diff で見たものを認定しようとします。それ以外の場合は、パッケージ名と 1 つのバージョン(全体監査の場合)、または 2 つのバージョン(差分監査の場合)を指定する必要があります。
パッケージとバージョンが決まったら、どの基準で認定するのかを推測します。まず check を実行し、チェックが失敗して、あなたの監査でこのパッケージの問題が解決しそうであれば、その修正のために推奨される基準を使います。check が通った場合は、積み残しに取り組んでいるものとみなし、代わりに suggest の推奨を使います。
これによって exemption が不要になった場合は、自動的に削除します。
使い方
cargo vet certify [OPTIONS] [PACKAGE] [VERSION1] [VERSION2]
引数
[PACKAGE]
監査済みとして認定するパッケージ
[VERSION1]
監査済みとして認定するバージョン
[VERSION2]
指定した場合は、代わりに version1->version2 の差分を認定します
オプション
--wildcard <WILDCARD>
指定した場合は、そのユーザー名のユーザー、またはその署名を持つ信頼する公開者に対して、ワイルドカード監査を認定します。
認定する日付の範囲は、–start-date と –end-date のオプションで指定してください。
注意: 信頼する公開者の署名は、プロバイダーごとに決まった形式になっています。
- GitHub Actions:
github:organization/repository
--criteria <CRITERIA>
この監査で認定する基準
指定しなかった場合は、この情報の入力を求めます。
--who <WHO>
監査者として記載する名前
指定しなかった場合は、ローカルの git からこの情報を取得します。
--notes <NOTES>
新しい監査エントリに含める、自由形式の文字列
指定しなかった場合、メモは付きません。
--start-date <START_DATE>
作成するワイルドカード監査の開始日。
--wildcard と一緒に指定した場合にだけ有効です。
指定しなかった場合は、そのユーザーが最初に公開したバージョンの公開日になります。
--end-date <END_DATE>
作成するワイルドカード監査の終了日。最大で 1 年先まで指定できます。
--wildcard と一緒に指定した場合にだけ有効です。
指定しなかった場合は、現在の日付から 1 年後になります。
--accept-all
対話的な確認なしで、すべての基準を受け入れます
--force
パッケージとバージョンの指定が妥当かどうかを、コマンドに無視させます
打ち間違いや勘違いに気づけるように、指定されたものが現在のビルドに含まれているかどうかを確認しますが、このフラグはその確認を無効にします。
--no-collapse
直前の隣り合う、インポートできない git の監査がある場合に、それと今回の監査を 1 つにまとめないようにします。
指定した from のバージョンが git のバージョンである場合にだけ効果があります。
たとえば通常は、既存の 1.0.0->1.0.0@git:1111111 の監査と、新しく認定した 1.0.0@git:1111111->1.0.0@git:2222222 の監査は、1.0.0->1.0.0@git:2222222 という 1 つの監査にまとめられます。このフラグを渡すと、そうならなくなります。
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet import
新しいピアのインポートを取り込みます
URL の引数なしで実行すると、指定した名前のピアを cargo-vet のレジストリで探し、そのピアをインポートします。
使い方
cargo vet import [OPTIONS] <NAME> [URL]...
引数
<NAME>
インポートするピアの名前
[URL]...
ピアの audits.toml ファイルの URL(複数指定できます)。
URL を指定しなかった場合は、指定した名前のピアを cargo-vet のレジストリで探して、インポート元の URL を決めます。
オプション
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet trust
指定したクレートと公開者を信頼します
使い方
cargo vet trust [OPTIONS] [PACKAGE] [PUBLISHER_IDENTIFIER]
引数
[PACKAGE]
信頼するパッケージ
–all を指定した場合を除いて、必ず指定してください。
[PUBLISHER_IDENTIFIER]
信頼する公開者のユーザー名、または信頼する公開者の署名
指定しなかった場合は、そのクレートについて知られている唯一の公開者であると推定します。そのクレートに複数の公開者がいる場合は、ログイン名を明示的に指定する必要があります。
オプション
--criteria <CRITERIA>
この信頼エントリで認定する基準
指定しなかった場合は、この情報の入力を求めます。
--start-date <START_DATE>
作成する信頼エントリの開始日。
指定しなかった場合は、そのユーザーが最初に公開したバージョンの公開日になります。
--end-date <END_DATE>
作成する信頼エントリの終了日。最大で 1 年先まで指定できます。
指定しなかった場合は、現在の日付から 1 年後になります。
--notes <NOTES>
新しい監査エントリに含める、自由形式の文字列
指定しなかった場合、メモは付きません。
--all <ALL>
指定した場合は、免除または失敗のあるパッケージのうち、指定したユーザーまたは信頼する公開者の署名だけによって公開されているものをすべて信頼します
--allow-multiple-publishers
–all と一緒に指定した場合は、少なくとも 1 つのバージョンが指定したユーザーによって公開されていれば、複数の公開者がいるパッケージも信頼します
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet regenerate
さまざまな情報を明示的に再生成します
cargo vet が自動的に行うこともできるものの、判断に人が関わり続けるように、あえて手動にしていることがいくつかあります。その中には、十分に退屈で信頼できるという合意が得られれば、いつか自動になるものもあるかもしれません。
詳しくは、各サブコマンドを参照してください。
使い方
cargo vet regenerate [OPTIONS] <COMMAND>
コマンド
- exemptions:
checkが最小限の免除で通るように、免除を再生成します - imports: インポートを再生成し、基準の変更を受け入れます
- audit-as-crates-io: 必要とするすべてのクレートのポリシーのエントリに
audit-as-crates-ioを追加します - unpublished: その後公開されたクレートや、より新しいバージョンとして監査すべきになったクレートについて、古くなった
unpublishedエントリをすべて削除します
オプション
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet regenerate exemptions
check が最小限の免除で通るように、免除を再生成します
このコマンドは 2 つの目的に使えます。サプライチェーンが現在 check に失敗しているときに強制的に通すことと、すでに通っているときに免除を最小化(ガベージコレクション)することです。この 2 つは、結局のところ同じ操作です。
既存の免除はできるかぎり残し、不要なものだけを削除して、必要なものだけを追加します。範囲が広すぎる免除は、弱められることもあります(つまり、safe-to-deploy が safe-to-run に引き下げられることがあります)。
使い方
cargo vet regenerate exemptions [OPTIONS]
オプション
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet regenerate imports
インポートを再生成し、基準の変更を受け入れます
これは cargo vet fetch-imports と同等ですが、外部の基準の説明が変わっていてもエラーにしません。
使い方
cargo vet regenerate imports [OPTIONS]
オプション
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet regenerate audit-as-crates-io
必要とするすべてのクレートのポリシーのエントリに audit-as-crates-io を追加します。
description と repository のエントリが、crates.io に公開されているクレートのものと一致するクレートは、audit-as-crates-io = true として記録されます。
使い方
cargo vet regenerate audit-as-crates-io [OPTIONS]
オプション
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet regenerate unpublished
その後公開されたクレートや、より新しいバージョンとして監査すべきになったクレートについて、古くなった unpublished エントリをすべて削除します。
cargo vet prune と違って、check が失敗し始めることになる場合でも、古くなった unpublished エントリを削除します。
使い方
cargo vet regenerate unpublished [OPTIONS]
オプション
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet add-exemption
パッケージをレビューの免除対象として記録します
免除はたいていの場合、単なる「積み残し」であり、「いずれは」レビューすることが期待されています。通常は減らしていくことだけを目指すべきですが、作業を前に進めるために追加が必要になることもあります。
regenerate exemptions は、check が通るようにこれを自動的に行うので(不要なものの削除もします)、add-exemption よりもそちらを使うことをおすすめします。このコマンドは主に、cargo vet の上にツールを作るための「下回りの部品」として用意されています。
使い方
cargo vet add-exemption [OPTIONS] <PACKAGE> <VERSION>
引数
<PACKAGE>
免除対象として記録するパッケージ
<VERSION>
免除対象として記録するバージョン
オプション
--criteria <CRITERIA>
満たしているものとみなす(信頼する)基準
指定しなかった場合は、この情報の入力を求めます。
--notes <NOTES>
新しい禁止エントリに含める、自由形式の文字列
指定しなかった場合、メモは付きません。
--no-suggest
この免除をレビューの候補として提案しないようにします
--force
パッケージとバージョンの指定が妥当かどうかを、コマンドに無視させます
打ち間違いや勘違いに気づけるように、指定されたものが現在のビルドに含まれているかどうかを確認しますが、このフラグはその確認を無効にします。
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet record-violation
パッケージの一部のバージョンが特定の監査基準に違反していることを宣言します
重要: 違反には Version ではなく VersionReq を指定します。これは、Cargo.toml で依存を指定するときに使うのと同じ構文です。単に 1.0.0 と書くと、実際には ^1.0.0 を意味します。特定の バージョンを禁止したい場合は、=1.0.0 を使ってください。* のような構文はスクリプトや端末で特別な意味を持つので、このコマンドは少し使いにくいことがあります。おそらく、audits.toml に手作業でエントリを追加するほうが簡単ですが、使いたい場合のためにコマンドを用意しています。
違反は、基本的にサプライチェーンに対する整合性の制約として扱われます。エラーになるのは、その violation と矛盾する基準を主張している exemptions や audits(インポートしたものを含みます)がある場合だけです。violation のあるパッケージに依存すること自体は、エラーではありません。
たとえば、誰かがあるパッケージをレビューして、信頼できない入力に対してひどく不健全であり、したがって safe-to-deploy ではない、と判断したとします。その人は、その問題がありそうなバージョンに対して “safe-to-deploy” の違反を追加するでしょう。しかし、そのパッケージが信頼できる入力に対しては基本的に問題なく動くのであれば、safe-to-run ではあるかもしれません。ですから、それをテストで使っていて、safe-to-run だけを主張する監査を持っている場合は、何も指摘しません。
違反によって整合性のエラーが実際に起きた場合、どう対処するかは、あなたとピアが考えることになります。ピアが公開した違反に同意できない場合に対処する仕組みは、まだありません。
使い方
cargo vet record-violation [OPTIONS] <PACKAGE> <VERSIONS>
引数
<PACKAGE>
禁止するパッケージ
<VERSIONS>
禁止するバージョン
オプション
--criteria <CRITERIA>
満たされなかった基準。
指定しなかった場合は、この情報の入力を求めます(?)
--who <WHO>
監査者として記載する名前
指定しなかった場合は、ローカルの git からこの情報を取得します。
--notes <NOTES>
新しい禁止エントリに含める、自由形式の文字列
指定しなかった場合、メモは付きません。
--force
パッケージとバージョンの指定が妥当かどうかを、コマンドに無視させます
打ち間違いや勘違いに気づけるように、指定されたものが現在のビルドに含まれているかどうかを確認しますが、このフラグはその確認を無効にします。
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet fmt
vet のすべてのファイルを整形し直します(手で編集した場合のため)
ほとんどのコマンドが暗黙のうちにこれを行うので、このコマンドは主に、vet の上にツールを作るための「下回りの部品」として、あるいはほかのコマンドを実行したくない場合のために用意されています。
使い方
cargo vet fmt [OPTIONS]
オプション
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet prune
不要なインポートと免除を刈り込みます
インポートの最新の状態を取得し、もう不要になったインポートや免除をサプライチェーンから取り除こうとします。
使い方
cargo vet prune [OPTIONS]
オプション
--no-imports
使われていないインポートを刈り込みません
--no-exemptions
使われていない免除を刈り込みません
--no-audits
使われていない、インポートできない監査を刈り込みません
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet aggregate
複数の取得元から監査を取得し、1 つの audits.toml ファイルにまとめます。
指定したファイルに書かれた各 URL から監査を取得し、1 つのファイルに結合します。独自の基準は名前を単位として統合され、取得元のどの監査ファイルでも説明が同一でなければなりません。
使い方
cargo vet aggregate [OPTIONS] <SOURCES>
引数
<SOURCES>
監査の集約元となる URL の一覧が書かれたファイルへのパス
オプション
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet explain-audit
指定した基準でパッケージを認定するために cargo-vet が算出した監査の経路を表示します。
これはデバッグ用のコマンドで、出力の形式は保証されません。
使い方
cargo vet explain-audit [OPTIONS] <PACKAGE> [VERSION] [CRITERIA]
引数
<PACKAGE>
監査の経路を表示するパッケージ
[VERSION]
監査の経路を表示するバージョン
[CRITERIA]
監査の経路を表示する基準
[default: safe-to-deploy]
オプション
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet dump-graph
cargo vet が把握している cargo のビルドグラフを表示します
これはデバッグ用のコマンドで、出力の形式は保証されません。cargo が考えるビルドグラフを安定した形で得るには、cargo metadata を使ってください。私たちのグラフは、その結果をもとにしています。
--output-format=human(既定)では、mermaid-js の図を出力します。これは、github などがそのまま描画に対応しています。
--output-format=json では、検索や分析に使えるように、より生に近い統計情報を出力します。
ほとんどのプロジェクトのビルドグラフは、読めないほど複雑です。そのため、グローバルな --filter-graph 引数を使って、関心のある部分グラフに絞り込むとよいでしょう。--filter-graph は、意味の分析を行う前に適用されます。そのため、あるパッケージを取り除いたときに、それが問題の原因だった場合は、問題が消えます。フィルターを十分に工夫すれば、これを使って問題を二分探索で絞り込めます。
使い方
cargo vet dump-graph [OPTIONS]
オプション
--depth <DEPTH>
表示するグラフの深さ(大きなプロジェクトでは、グラフの全体はひどくごちゃごちゃしています)
[default: first-party]
[possible values: roots, workspace, first-party, first-party-and-directs, full]
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet gc
vet のキャッシュから古いパッケージを片づけます
しばらくアクセスされていないパッケージを削除し、cargo-vet が認識しない余分なファイルもすべて削除します。
将来は、cargo-vet の多くのサブコマンドが、暗黙のうちにこれを行うようになります。
使い方
cargo vet gc [OPTIONS]
オプション
--max-package-age-days <MAX_PACKAGE_AGE_DAYS>
vet のキャッシュにあるパッケージのうち、この日数のあいだ使われていないものを削除します
[default: 30]
--clean
キャッシュディレクトリを丸ごと削除し、次に cargo vet を使うときに再生成させます
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます
cargo vet renew
ワイルドカード監査の有効期限を更新します
ワイルドカード監査の有効期限を、実行した時点から 1 年後に設定します。オプションを指定すれば、まもなく期限が切れるすべての監査に対して、これを行うこともできます。
使い方
cargo vet renew [OPTIONS] [CRATE]
引数
[CRATE]
更新するクレートの名前
オプション
--expiring
今から 6 週間後までに期限が切れるワイルドカード監査を、すべて更新します
--include-inactive
4 か月間更新されていない、活動のないクレートのワイルドカード監査も更新します
-h, --help
ヘルプを表示します(’-h’ では要約を表示します)
グローバルオプション
このサブコマンドは、すべてのグローバルオプションを受け付けます