Ergonomia della CLI
Create strumenti a riga di comando intuitivi: help chiaro, flag brevi, codici di uscita, stdout e stderr, analisi di base e semplice gestione della verbosità.
Ergonomia della CLI è una lezione C# Academy gratuita su CoddyKit. Questa è la lezione 3 di 3. Puoi leggere la lezione completa qui gratuitamente — poi esercitati direttamente nel browser con un editor di codice integrato e un tutor IA disponibile 24/7. Fa parte del percorso di apprendimento C# Academy, e i tuoi progressi si sincronizzano tra il web e l'app CoddyKit. Il corso C# Academy include 3 lezioni in totale.
Nozioni di base per una CLI intuitiva
Obiettivi:
- Mostrare la guida con -h/--help
- Utilizzare flag chiari (-i, -o, --verbose)
- Restituire 0 in caso di successo, un valore diverso da zero in caso di errore
- Inviare i risultati a stdout e le informazioni diagnostiche a stderr
Utilizzo e guida
Aggiunga una breve sezione sull'utilizzo e accetti sia flag brevi sia lunghi; la mostri quando manca l'input.
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
}
}
Flag e codici di uscita
Restituisca un valore diverso da zero in presenza di flag non validi; mantenga brevi e specifici i messaggi. Stampi l'esito positivo su 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 e stderr
Inserisca i risultati in stdout (utilizzabile nelle pipe) e le informazioni diagnostiche in stderr. Aggiunga un semplice flag --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;
}
}
Convenzioni e rifiniture
- Accetti sia flag brevi sia lunghi (-h/--help)
- Utilizzi messaggi di errore chiari (che cosa non va e come correggerlo)
- Mantenga minimo l'output predefinito; aggiunga --verbose per i dettagli
- Utilizzi codici di uscita coerenti (0 successo, 1 argomenti non validi, 2 errore di I/O)
Smoke test e documentazione
- Provi il reindirizzamento: command > out.txt e command 2> err.txt
- Testi i percorsi di errore: file mancante, argomenti errati
- Mantenga il testo di utilizzo entro circa 5 righe sui dispositivi mobili
- Documenti esempi facili da copiare e incollare
Stream e codici di uscita
Riepilogo
Riepilogo: la guida su -h/--help, flag chiari, codici di uscita corretti e separazione tra stdout e stderr rendono gli strumenti facili da usare negli script e prevedibili.
Domande Frequenti
La lezione «Ergonomia della CLI» è gratuita?
Sì — il testo completo di «Ergonomia della CLI» è gratuito qui sul web. Per esercitarvi in modo interattivo (un editor di codice integrato e un tutor IA 24/7) e sbloccare il resto del corso C# Academy, passa a CoddyKit PRO. Il corso C# Academy include 3 lezioni in totale.
Cosa imparerò in «Ergonomia della CLI»?
Create strumenti a riga di comando intuitivi: help chiaro, flag brevi, codici di uscita, stdout e stderr, analisi di base e semplice gestione della verbosità. Eserciti C# Academy con codice pratico che esegui direttamente nel browser, e un tutor IA 24/7 risponde alle tue domande mentre lavori sulla lezione.
Ho bisogno di esperienza per iniziare C# Academy?
Non è richiesta alcuna esperienza precedente. C# Academy su CoddyKit è strutturato per principianti e studenti avanzati, quindi puoi iniziare da qui o dall'inizio e procedere al tuo ritmo. Questa è la lezione 3 di 3.
Quanto tempo richiede la lezione «Ergonomia della CLI»?
La maggior parte delle lezioni CoddyKit richiede circa 5–10 minuti. Ogni lezione è breve e interattiva, quindi fai progressi costanti e riprendi esattamente da dove hai lasciato su web e app.
Posso scrivere ed eseguire codice in questa lezione C# Academy?
Sì. Ogni lezione C# Academy include un editor di codice integrato, quindi scrivi ed esegui codice reale direttamente nel tuo browser e ricevi feedback istantaneo dall'IA — nessuna configurazione locale necessaria.
Tutte le lezioni di questo corso
- Scripting C# (dotnet script), snippet e REPL
- Fondamenti dell’interoperabilità (P/Invoke) in breve
- Ergonomia della CLI