[章番号]: [ツール名] CLI仕様書
このテンプレートの使い方
このファイルは、コマンドラインインターフェース（CLI）ツールの仕様を定義するためのテンプレートです。
ユーザーがターミナルで入力するコマンド、引数、オプションの仕様を定義することに重点を置きます。
詳しい使い方は「設計仕様の書き方ガイド」を参照してください。
1. はじめに
1.1. 目的
1.2. 対象読者
2. 基本情報
| 項目 |
内容 |
| コマンド名 |
[例: my-tool] |
| インストール方法 |
[例: npm install -g my-tool] |
3. グローバルオプション
| オプション |
エイリアス |
説明 |
--help |
-h |
ヘルプメッセージを表示する。 |
--version |
-v |
バージョン情報を表示する。 |
--verbose |
|
詳細なログを出力する。 |
--config <path> |
-c <path> |
設定ファイルのパスを指定する。 |
4. コマンド一覧
| コマンド |
説明 |
my-tool init |
新しいプロジェクトを初期化する。 |
my-tool build |
プロジェクトをビルドする。 |
my-tool deploy |
ビルドした成果物をデプロイする。 |
5. コマンド詳細
5.1. init
- 概要: カレントディレクトリに、新しいプロジェクトの設定ファイルを生成する。
- 使用法:
my-tool init [options]
オプション
| オプション |
エイリアス |
型 |
説明 |
--force |
-f |
boolean |
既存の設定ファイルがあっても上書きする。 |
--template <name> |
-t <name> |
string |
使用するテンプレート名を指定する。デフォルトは default。 |
使用例
# カレントディレクトリにデフォルト設定で初期化
my-tool init
# 'react'テンプレートを使い、既存ファイルを上書き
my-tool init --template react --force
出力 (stdout)
成功した場合、生成されたファイルの一覧と完了メッセージを出力する。
終了コード
0: 成功1: 失敗（ファイル書き込みエラーなど）
5.2. deploy
- 概要: ビルド済みの成果物を指定された環境にデプロイする。
- 使用法:
my-tool deploy <environment> [options]
引数
| 引数名 |
必須 |
説明 |
environment |
Yes |
デプロイ先の環境名 (staging または production)。 |
オプション
| オプション |
エイリアス |
型 |
説明 |
--dry-run |
|
boolean |
実際にはデプロイせず、実行されるコマンドを表示する。 |
--tag <tag> |
|
string |
デプロイする成果物のバージョンタグを指定する。 |
使用例
# staging環境にデプロイ
my-tool deploy staging
# production環境にv1.2.0をデプロイ（ドライラン）
my-tool deploy production --tag v1.2.0 --dry-run
出力 (stdout)
デプロイの進捗状況と結果を出力する。
終了コード
0: 成功1: 失敗（認証エラー、ビルド成果物なしなど）2: 不正な環境名が指定された。