dfx config

現在のプロジェクトの設定ファイルのセッティングを見るには、dfx config コマンドを使用します。 このコマンドはプロジェクトのディレクトリ構造内からのみ実行できることに注意してください。 例えば、プロジェクト名が hello_world の場合、現在の作業ディレクトリは hello_world のトップレベルのプロジェクトディレクトリかそのサブディレクトリのいずれかである必要があります。

基本的な利用法

dfx config [config_path] [value] [flag]

フラグ

dfx config コマンドでは、以下のオプションフラグを使用することができます。

フラグ 説明

-h, --help

利用情報を表示します。

-V, --version

バージョン情報を表示します。

オプション

dfx config コマンドでは、以下のオプションを使用することができます。

オプション 説明

--format

設定ファイルの出力形式を指定します。 JSON 形式がデフォルトで表示されます。 有効な値は json と text です。

引数

dfx config コマンドには、以下の引数を指定することができます。

引数 説明

config_path

セッティング、または読み込みを行う設定オプションの名前を指定します。 値のセットあるいは閲覧を行いたいオプションの設定名を指定します。変更あるいは閲覧したい特定のオプションを指定するには、ピリオドで区切られたパスを使用する必要があります。 特定の設定オプションへのパスを指定しない場合、コマンドは設定ファイル全体を表示します。

value

変更するオプションの新しい値を指定します。 値を指定しない場合、コマンドは設定ファイルからそのオプションの現在の値を返します。

例

dfx config コマンドを使用すると、デフォルトの出力ディレクトリの場所やメインプログラムのファイル名などの設定ファイルのセッティングを変更することができます。

例えば、デフォルトのビルド出力ディレクトリを canisters から staging に変更する場合は、以下のコマンドを実行します：

dfx config defaults.build.output "staging/"

設定の現在値を表示するには、値を指定せずに設定ファイルの設定値へのパスを指定します。 例えば：

dfx config defaults.build.output

このコマンドは、設定オプションの現在の値を返します。

"staging/"

同様に、以下のようなコマンドを実行することで、メインソースファイルの名前やローカル Canister 実行環境のポート番号も変更することができます：

dfx config canisters.hello.main "src/hello_world/hello-main.mo"
dfx config networks.local.bind 127.0.0.1:5050

また、dfx config コマンドを実行した後に dfx.json 設定ファイルを見ることで、設定の変更を確認することができます。