CCNEX
CLI ヘルプ
BASIC
基本構文と共通仕様
CCNEX CLI は、コマンドごとに必要なオプションを指定して実行します。
共通的に --input と
--output を使用し、ログ出力や上書き制御も統一的に扱います。
基本構文
CCNEX.Cli.exe <command> [options]
利用可能なコマンド:
- encrypt
- decrypt
- compress
- extract
- protect
共通オプション
| オプション | 概要 |
|---|---|
| --input | 入力パス。全コマンドで必須。複数指定可。 |
| --output | 出力先パス。全コマンドで必須。 |
| --overwrite | ask / skip / replace。既定値は ask。 |
| --log-file | ログファイル出力先。 |
| --log-level | info / warn / error / debug。既定値は info。 |
| --quiet | 標準出力を抑制。 |
| --verbose | 詳細出力を有効化。 |
| --help | ヘルプを表示して終了。 |
※ --quiet と --verbose は排他です。
PASSWORD / KEY
パスワード入力と鍵ファイル
暗号化・復号系コマンドでは、パスワード入力方式と鍵ファイルの指定方法を選択できます。 パスワードの平文直書き引数は初版では採用していません。
パスワード入力方式
| オプション | 概要 |
|---|---|
| --password-stdin | 標準入力からパスワードを取得。 |
| --password-env | 指定した環境変数名からパスワードを取得。 |
| 未指定 | 対話入力で取得。 |
※ --password-stdin と --password-env は排他です。
鍵ファイル関連
| オプション | 概要 |
|---|---|
| --mode | password / password-key |
| --generate-key-file | encrypt / protect で鍵ファイル生成先を指定。 |
| --key-file | decrypt 時に鍵ファイルを明示指定。 |
--mode password-key では --generate-key-file が必須です。
COMMANDS
コマンド別の使い方
主要コマンドごとに、用途、基本構文、代表的な実行例を整理しています。 実際の運用では、バッチファイルやスケジューラ、業務自動化処理からの呼び出しも想定できます。
encrypt
単体ファイルを暗号化します。
CCNEX.Cli.exe encrypt --input "C:\data\a.txt" --output "C:\out\a.enc"
CCNEX.Cli.exe encrypt --mode password-key --input "C:\data\a.txt" --output "C:\out\a.enc" --generate-key-file "C:\keys\a.enckey"
protect
ZIP圧縮後に暗号化します。フォルダ暗号化の正規ルートです。
CCNEX.Cli.exe protect --input "C:\data\folder" --output "C:\out\folder.enc"
decrypt
.enc ファイルを復号します。
CCNEX.Cli.exe decrypt --input "C:\data\a.enc" --output "C:\out"
CCNEX.Cli.exe decrypt --input "C:\data\a.enc" --output "C:\out" --key-file "C:\keys\a.enckey"
compress / extract
ZIP圧縮および解凍を行います。
CCNEX.Cli.exe compress --input "C:\data\folder" --output "C:\out\folder.zip"
CCNEX.Cli.exe extract --input "C:\data\folder.zip" --output "C:\out"
PARAMETERS
主要パラメータ一覧
実装初版で重要となるパラメータと制約を抜粋しています。 詳細な仕様運用では、入力制約、排他条件、終了コードもあわせて確認してください。
| パラメータ | 対象 | 内容 |
|---|---|---|
| --input | 全コマンド | 必須。1個以上の入力パス。 |
| --output | 全コマンド | 必須。出力先フォルダまたは出力ファイル。 |
| --overwrite | 全コマンド | ask / skip / replace。既定値 ask。 |
| --log-file | 全コマンド | ログファイル保存先。 |
| --log-level | 全コマンド | info / warn / error / debug。 |
| --mode | encrypt / protect | password / password-key。 |
| --generate-key-file | encrypt / protect | password-key モード時に必須。 |
| --key-file | decrypt | 高セキュリティモード復号時に条件付き必須。 |
| --name-mode | decrypt / extract | restore-original / suffix / suffix-timestamp。 |
| --quiet | 全コマンド | 標準出力を抑制。--verbose と排他。 |
| --verbose | 全コマンド | 詳細出力を有効化。--quiet と排他。 |
| --help | 全コマンド | ヘルプ表示。必須チェックを行わず終了コード 0。 |
EXIT CODES
終了コード
バッチ処理や自動化から利用する場合は、終了コードにより正常終了・引数不正・鍵関連エラー等を判定できます。
| 終了コード | 意味 |
|---|---|
| 0 | 全成功 |
| 1 | 一般失敗 |
| 2 | 引数不正 |
| 3 | 入力不正 / 入力なし |
| 4 | パスワード / 鍵関連エラー |
| 5 | 出力エラー |
| 6 | 一部成功 |
| 7 | キャンセル |
| 8 | 内部例外 |
| 9 | 形式不正 / ヘッダ不正 |
| 10 | 上書き拒否による未完了 |
補足
CLI の詳細仕様は、実装バージョンに応じて更新される場合があります。実運用時は、対象バージョンに対応したヘルプ表示やリリースノートもあわせて確認してください。