Dokumentacja referencyjna
Dokumentacja CLI
Angielska wersja tej strony zmieniła się od czasu tłumaczenia. Aktualna jest strona angielska. Przeczytaj po angielsku
Każde polecenie, które rejestruje Oloproof, wraz z opisem jego działania. Każde przyjmuje --help, które wypisuje pełny tekst, z którego pochodzą te streszczenia.
Ta strona jest generowana z CLI przez scripts/generate_cli_reference.py. Ręczna edycja nie ma sensu: następne uruchomienie ją nadpisuje, a make check kończy się niepowodzeniem, dopóki zatwierdzona kopia jest nieaktualna.
Polecenia
| Polecenie | Co robi |
|---|---|
| oloproof audit | Każde działanie, jakie osoba wykonała w tym projekcie, i co każde z nich dowodzi. |
| oloproof compare | Raportuje sparowane liczności, różnice i decyzje dwóch zapisanych przebiegów. |
| oloproof credentials list | Nazwy przechowywane przez ten obszar roboczy. Nigdy wartości. |
| oloproof credentials set | Zapisuje klucz dostawcy dla tego obszaru roboczego, odczytany ze środowiska lub ze standardowego wejścia. |
| oloproof diagnose | Ponownie wykonuje nieudane przypadki przebiegu z kontekstem wzorcowym, w ramach interwencji. |
| oloproof doctor | Raportuje środowisko Pythona, platformy i dostawców, jakie oferuje ta maszyna. |
| oloproof evaluators calibrate | Mierzy deklarowane prawdopodobieństwa sędziego probabilistycznego względem ludzi i dopasowuje korektę. |
| oloproof evaluators list | Wyświetla każdą zapisaną wersję ewaluatora ze statusem, który odczytałaby decyzja. |
| oloproof evaluators probe | Sonduje sędziego bez etykiet: jak często jego werdykt się zmienia, gdy nie zmieniło się nic istotnego. |
| oloproof evaluators retire | Wycofuje zaufanie do wersji ewaluatora. Ostateczne: aby ją zastąpić, należy zapisać nową wersję. |
| oloproof evaluators try | Mierzy roboczy ewaluator względem już zapisanych etykiet i niczego nie waliduje. |
| oloproof evaluators validate | Mierzy ewaluator względem zapisanych etykiet ludzkich i waliduje go na podstawie tych dowodów. |
| oloproof export | Zapisuje przenośny pakiet dla przebiegu, porównania lub wersji ewaluatora. |
| oloproof gate | Rozstrzyga wydanie względem polityki i kończy działanie z kodem decyzji. |
| oloproof init | Tworzy szkielet projektu: przykładowy system, oloproof.yaml i release.yaml. |
| oloproof inspect | Odczytuje zapisany przebieg, przypadek, porównanie lub diagnozę. |
| oloproof job | Co stało się z zarządzanym zadaniem; kończy działanie z kodem bramki przebiegu, który ono utworzyło. |
| oloproof labels export | Zapisuje przypadki do pliku CSV do etykietowania przez ludzi: ślepą próbę losową lub przypadki do przeglądu. |
| oloproof labels import | Zapisuje każdy wypełniony wiersz pliku etykietowania jako etykietę albo nie zapisuje żadnego. |
| oloproof login | Łączy ten terminal z obszarem roboczym poprzez zatwierdzenie w przeglądarce. |
| oloproof plan | Czego potrzeba, by rozstrzygnąć to, czego ten przebieg lub porównanie nie mogło. |
| oloproof prefer | Który z dwóch przebiegów odpowiadał lepiej, według sędziego parami pytanego w obu kolejnościach. |
| oloproof push | Wysyła dowody przebiegu do obszaru roboczego. |
| oloproof review | Etykietuje przypadki jeden po drugim w terminalu, zapisując każdy werdykt w chwili jego wydania. |
| oloproof run | Wykonuje każdy przypadek względem systemu i zapisuje dowody. |
| oloproof signoff | Zapisuje wydanie mimo zablokowanej bramki, z dwiema osobami zatwierdzającymi i pisemnym uzasadnieniem. |
| oloproof usage | Co zużył ten projekt, zmierzone na podstawie jego własnych dowodów. |
Kody wyjścia
Każde polecenie używa tych samych kodów. Bramkowanie CI wymienia znaczenie każdego z nich oraz kolejność, w jakiej są zgłaszane, gdy zablokowana jest więcej niż jedna bramka.