0Pricing
C# Academy · Leçon

Ergonomie de la CLI

Construisez des outils en ligne de commande conviviaux : aide claire, indicateurs courts, codes de sortie, stdout et stderr, analyse de base et verbosité simple.

Ergonomie de la CLI est une leçon C# Academy gratuite sur CoddyKit. Ceci est la leçon 3 sur 3. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage C# Academy, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours C# Academy comprend 3 leçons au total.

Principes d’une CLI conviviale

Objectifs :

  • Afficher l’aide avec -h/--help
  • Utiliser des options claires (-i, -o, --verbose)
  • Retourner 0 en cas de succès et une valeur différente de zéro en cas d’erreur
  • Envoyer les résultats vers la sortie standard et les diagnostics vers la sortie d’erreurs standard

Utilisation et aide

Ajoutez une courte section sur l’utilisation et acceptez les options courtes comme les options longues ; affichez-la lorsque l’entrée est absente.

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
  }
}

Options et codes de sortie

Retournez une valeur différente de zéro lorsque les options sont invalides ; gardez des messages courts et précis. Affichez la réussite sur la sortie standard.

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;
  }
}

Sortie standard ou sortie d’erreurs

Placez les résultats sur la sortie standard (compatible avec les tubes), et les diagnostics sur la sortie d’erreurs standard. Ajoutez une option simple --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;
  }
}

Conventions et finition

  • Acceptez les options courtes comme les options longues (-h/--help)
  • Utilisez des messages d’erreur clairs (le problème et sa résolution)
  • Gardez une sortie minimale par défaut ; ajoutez --verbose pour plus de détails
  • Utilisez des codes de sortie cohérents (0 en cas de succès, 1 pour des arguments invalides, 2 en cas d’échec d’entrée-sortie)

Tests rapides et documentation

  • Essayez la redirection : commande > out.txt et commande 2> err.txt
  • Testez les chemins d’erreur : fichier manquant, arguments incorrects
  • Gardez le texte d’utilisation sous environ 5 lignes sur mobile
  • Documentez des exemples faciles à copier-coller

Flux et codes de sortie

Vérification rapide : quelle pratique améliore la convivialité d’une CLI et le raccordement aux tubes du shell ?

Récapitulatif

Récapitulatif : l’aide avec -h/--help, des options claires, des codes de sortie appropriés et la séparation entre la sortie standard et la sortie d’erreurs standard rendent vos outils faciles à utiliser dans des scripts et prévisibles.

Questions Fréquemment Posées

La leçon « Ergonomie de la CLI » est-elle gratuite ?

Oui — le texte complet de « Ergonomie de la CLI » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours C# Academy, passe à CoddyKit PRO. Le cours C# Academy comprend 3 leçons au total.

Qu'est-ce que j'apprendrai dans « Ergonomie de la CLI » ?

Construisez des outils en ligne de commande conviviaux : aide claire, indicateurs courts, codes de sortie, stdout et stderr, analyse de base et verbosité simple. Tu pratiques C# Academy avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.

Dois-je avoir de l'expérience pour commencer C# Academy ?

Aucune expérience préalable n'est requise. C# Academy sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 3 sur 3.

Combien de temps prend la leçon « Ergonomie de la CLI » ?

La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.

Peux-tu écrire et exécuter du code dans cette leçon C# Academy ?

Oui. Chaque leçon C# Academy inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.

Toutes les leçons de ce cours

  1. Scripting C# (dotnet script), extraits et REPL
  2. Principes de l’interopérabilité (P/Invoke) en bref
  3. Ergonomie de la CLI
← Retour à C# Academy