create-cli

Umiejętność do projektowania interfejsów linii poleceń zanim zaczniesz kodować. Definiujesz strukturę komend, flagi, argumenty, teksty pomocy, formaty wyjścia, kody błędów i reguły bezpieczeństwa. Przydatna zarówno przy tworzeniu nowych CLI od podstaw, jak i przy refaktoryzacji istniejących interfejsów pod kątem spójności, łatwości użycia i odkrywalności. Bazuje na sprawdzonych wytycznych z clig.dev.

1. Przygotuj podstawowe informacje o swoim CLI: nazwę komendy i jedno zdanie opisujące jej cel. Określ, czy będzie używana głównie przez ludzi, skrypty czy oba.

2. Wyjaśnij źródła danych wejściowych – czy będziesz przyjmować argumenty, dane ze standardowego wejścia, pliki czy adresy URL. Zastanów się, jak będziesz obsługiwać dane wrażliwe (nigdy przez flagi).

3. Zdefiniuj kontrakt wyjścia: czy chcesz tekst dla człowieka, opcję --json dla maszyn, --plain dla skryptów. Określ też kody wyjścia dla głównych scenariuszy błędów.

4. Zdecyduj o interaktywności: czy CLI będzie pytać użytkownika o potwierdzenie, czy potrzebujesz flagi --no-input dla trybu nieinteraktywnego. Zaplanuj --dry-run dla operacji destrukcyjnych.

5. Ustal model konfiguracji i kolejność priorytetów: flagi powinny przesłaniać zmienne środowiskowe, które przesłaniają plik konfiguracji projektu, który przesłania konfigurację użytkownika. Wybierz między standardem XDG a konfiguracją lokalną w repozytorium.

6. Umiejętność wygeneruje kompletną specyfikację: drzewo komend, tabelę argumentów i flag z typami i przykładami, semantykę podkomend, reguły bezpieczeństwa i mapę kodów błędów – gotowe do implementacji.