NDCLI の使い方
NDCLI の基本的な使い方について以下の流れでご説明します。
- コマンドラインエクステンションの開発
- コマンドラインエクステンションの配置
- ライセンス登録
- コマンドラインエクステンションの実行
- ライセンス解除
コマンドライ ンエクステンションの開発
まずは、NDCLI で独自機能を実行するためにコマンドラインエクステンションを開発します。 詳細は次のページを参照してください。
コマンドラインエクステンションの配置
NDCLI の実行環境にコマンドラインエクステンションを配置します。 詳細は次のページを参照してください。
ライセンス登録
NDCLI でコマンドラインエクステンションを実行するには Next Design のライセンスが必要です。 デスクトップ版 Next Design からライセンス登録されていない場合は、NDCLI からライセンス登録します。 ライセンスの種類はユーザー ライセンス、フローティングライセンスのいずれでも登録可能です。
ライセンス登録は組込みコマンドを使用して行います。コマンドの詳細は次のページを参照してください。
コマンドラインエクステンションの実行
NDCLI からコマンドラインエクステンションで実装されたコマンドやサブコマンドを実行します。
NDCLI コマンド構文はコマンドとコマンドの引数、サブコマンドとサブコマンドの引数、または、オプションで構成されます。
ndcli <command> [<params>] [<--option> [params]]
ndcli <command> <subcommand> [<params>] [<--option> [params]]
ndcli <--option>
例:
> ndcli license activate --key <KEY> --email <EMAIL>
> ndcli my-cli-extension IFExport --project someproject.nproj --output-folder ./interfaces
> ndcli --help
> ndcli --version
-
コマンド
NDCLI 標準の組込みコマンドまたはコマンドラインエクステンションに実装されたコマンドを指定します。 コマンドはサブコマンドを持つことができます。サブコマンドにさらにサブコマンドを持たせることもできます。例えば、
ndcli my-cli-extension IFExport
はmy-cli-extension
コマンドが持つIFExport
サブコマンドが実行されます。本書では、サブコマンドも含めてコマンドと総称します。
-
引数(パラメータ)
コマンドやオプションに引数を渡せます。例えば、
ndcli my-cli-extension verify <modelid>
を実行した場合、my-cli-extension verify
コマンドに<modelid>
が引き渡されます。 -
オプション
コマンドにオプションを指定できます。例えば、
ndcli license add --key <KEY> --email <EMAIL>
を実行した場合、license add
コマンドに--key
オプションとその引数<KEY>
、--email
オプションその引数<EMAIL>
が引き渡されます。
- ndcli --help を実行すると、利用可能なオプションやコマンドが表示されます。
- 利用可能なコマンドは ndcli のバージョンとインストール済みのコマンドラインエクステンションによります。
PS> ndcli --help
Usage:
ndcli [options] [command]
Options:
--version Display version information
Commands:
license The command that manages license.
ライセンス解除
NDCLI から登録したライセンスを別環境でも使用する場合は、コマンドラインエクステンション実行後に NDCLI からライセンス解除します。
ライセンス解除は組込みコマンドを使用して行います。コマンドの詳細は次のページを参照してください。
- NDCLI の実行環境でデスクトップ版 Next Design からライセンス登録を行っている場合はライセンス解除しないでください。 NDCLI とデスクトップ版 Next Design のライセンスは共用のため、NDCLI でライセンス解除するとデスクトップ版 Next Design でもライセンス解除されます。