CLIツールのREADMEテンプレート

CLIツールのREADMEを作成する

コマンドラインツールには、ライブラリとは異なるドキュメントニーズがあります。ユーザーはインストール方法、コマンド構文、利用可能なフラグ、設定オプションを理解する必要があります。READMEはクイックスタートガイドとリファレンスマニュアルの両方として機能する必要があります。

インストール方法

CLIツールは通常、複数のインストールパスを提供します：

# グローバルインストール（推奨）
npm install -g my-cli

# インストールせずに実行
npx my-cli

# Homebrew（該当する場合）
brew install my-cli

CLIツールは通常システム全体のコマンドとして使用されるため、グローバルインストールを最初に表示します。

コマンド構文

明確な構文パターンでプライマリコマンドを文書化します：

my-cli <command> [options]

Commands:
  init          新しいプロジェクトを初期化
  build         プロジェクトをビルド
  deploy        本番環境にデプロイ
  config        設定を管理

Options:
  -v, --version    バージョン番号を表示
  -h, --help       ヘルプを表示
  --verbose        詳細出力を有効化
  --config <path>  設定ファイルのパス

実用的な例

CLIのREADMEは実世界の例から大きな利益を得ます。一般的なワークフローを示してください：

# 新しいプロジェクトを作成
my-cli init my-app --template react

# カスタム出力でビルド
my-cli build --output ./dist --minify

# ステージングにデプロイ
my-cli deploy --env staging --dry-run

設定ファイル

ツールが設定ファイルをサポートしている場合、形式と利用可能なオプションを文書化します。

終了コード

スクリプトとCI統合のために終了コードを文書化します：

• 0 - 成功
• 1 - 一般的なエラー
• 2 - 無効な引数