C# Academy · レッスン

CLIの使いやすさ

使いやすいコマンドラインツールを作ります。明確なヘルプ、短いフラグ、終了コード、stdoutとstderr、基本的な解析、シンプルな詳細度設定を扱います。

「CLIの使いやすさ」はCoddyKit上の無料C# Academyレッスンです。これはレッスン3/3です。下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。これはC# Academy学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 C# Academyコースには全3レッスンが含まれています。

使いやすいCLIの基本

目標:

-h/--helpでヘルプを表示します
わかりやすいフラグ（-i、-o、--verbose）を使用します
成功時は0、エラー時は0以外を返します
結果はstdoutに、診断情報はstderrに送信します

使い方とヘルプ

短い使い方セクションを追加し、短形式と長形式の両方のフラグを受け付けます。入力がない場合は使い方を表示します。

using System;

// A tiny CLI that prints help if no args or -h/--help is passed.
public class Program
{
  static void PrintUsage()
  {
    Console.WriteLine("usage: tool -i <input> [-o <output>] [--verbose]");
    Console.WriteLine("options:");
    Console.WriteLine("  -i, --input     input file path (required)");
    Console.WriteLine("  -o, --output    output file path (optional)");
    Console.WriteLine("  -h, --help      show help");
    Console.WriteLine("      --verbose   print extra diagnostics to stderr");
  }

  public static void Main(string[] args)
  {
    if (args.Length == 0 || args[0] == "-h" || args[0] == "--help")
    {
      PrintUsage();
      Environment.ExitCode = 0;
      return;
    }

    Console.WriteLine("OK: arguments received"); // placeholder success
  }
}

フラグと終了コード

無効なフラグの場合は0以外を返し、メッセージは短く具体的にします。成功時の出力はstdoutに表示します。

using System;

// Minimal manual parsing for beginners (no external libs).
public class Program
{
  static void Error(string msg)
  {
    Console.Error.WriteLine("error: " + msg);
    Environment.ExitCode = 1; // non-zero means failure
  }

  public static void Main(string[] args)
  {
    string input = null;
    string output = null;

    for (int i = 0; i < args.Length; i++)
    {
      string a = args[i];
      if (a == "-i" || a == "--input")
      {
        if (i + 1 >= args.Length) { Error("missing value for " + a); return; }
        input = args[++i];
      }
      else if (a == "-o" || a == "--output")
      {
        if (i + 1 >= args.Length) { Error("missing value for " + a); return; }
        output = args[++i];
      }
      else if (a == "-h" || a == "--help")
      {
        Console.WriteLine("usage: tool -i <input> [-o <output>]");
        return;
      }
      else
      {
        Error("unknown option: " + a);
        return;
      }
    }

    if (input == null) { Error("input is required (-i)"); return; }

    // Success path: write result to stdout
    Console.WriteLine("Processed " + input + (output == null ? "" : (" -> " + output)));
    Environment.ExitCode = 0;
  }
}

Stdoutとstderr

結果はstdoutに（パイプで使用できるように）、診断情報はstderrに出力します。簡単な--verboseフラグを追加します。

using System;

// Show separation of streams: stdout (results) vs stderr (diagnostics).
public class Program
{
  public static void Main(string[] args)
  {
    bool verbose = false;
    for (int i = 0; i < args.Length; i++) if (args[i] == "--verbose") verbose = true;

    if (verbose) Console.Error.WriteLine("info: starting work");
    // pretend to compute a number
    int result = 42;
    // Result goes to stdout so it can be piped:  tool ... > out.txt
    Console.WriteLine(result);

    if (verbose) Console.Error.WriteLine("info: finished work");
    Environment.ExitCode = 0;
  }
}

規約と仕上げ

短形式と長形式の両方のフラグ（-h/--help）を受け付けます
わかりやすいエラーメッセージ（問題の内容と解決方法）を使用します
デフォルトの出力は最小限にし、詳細には--verboseを使用します
終了コードを一貫させます（0: 成功、1: 引数が無効、2: I/Oエラー）

スモークテストとドキュメント

リダイレクトを試します: command > out.txtおよびcommand 2> err.txt
エラー経路（ファイルがない場合、引数が不正な場合）をテストします
モバイルでは使い方のテキストを約5行以内に保ちます
例を文書化し、コピーして貼り付けやすくします

ストリームと終了コード

確認問題: CLIの使いやすさとシェルでのパイプ処理を向上させる方法はどれですか

まとめ

まとめ: -h/--helpのヘルプ、わかりやすいフラグ、適切な終了コード、そしてstdout/stderrの分離により、ツールをスクリプトから使いやすく、予測しやすくできます。

よくある質問

「CLIの使いやすさ」レッスンは無料ですか？

はい。「CLIの使いやすさ」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、C# Academyコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 C# Academyコースには全3レッスンが含まれています。

「CLIの使いやすさ」で何を学びますか？

使いやすいコマンドラインツールを作ります。明確なヘルプ、短いフラグ、終了コード、stdoutとstderr、基本的な解析、シンプルな詳細度設定を扱います。ブラウザで直接実行するハンズオンコードでC# Academyを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

C# Academyを始めるのに経験は必要ですか？

事前経験は必要ありません。CoddyKitのC# Academyは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。これはレッスン3/3です。

「CLIの使いやすさ」レッスンにはどのくらい時間がかかりますか？

ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このC# Academyレッスンでコードを書いて実行できますか？

はい。すべてのC# Academyレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

← C# Academyに戻る