Flagi globalne
Flagi dostępne w każdym podpoleceniu aggrega.
--workspace-root <path>
Używa <path> jako katalogu głównego obszaru roboczego, całkowicie pomijając wykrywanie. Gdy flaga zostanie pominięta, aggrega wykrywa katalog główny, przechodząc w górę od bieżącego katalogu — albo, jeśli to przejście niczego nie znajdzie, a polecenie wskazuje swoją encję Release lub dokument ścieżką bezwzględną, przechodząc zamiast tego w górę od folderu tego pliku; w sekcji Konfiguracja opisano, co wyznacza katalog główny, w jakiej kolejności i które polecenia wskazują taki plik.
AGGREGA_WORKSPACE_ROOT jest odpowiednikiem w postaci zmiennej środowiskowej: gdy nie podano --workspace-root, katalog główny dostarcza ta zmienna. Jeśli flaga jest ustawiona, ma pierwszeństwo.
Katalog główny jest katalogiem głównym niezależnie od miejsca, w którym go podano, także w przypadku serwerów: żądanie do aggrega mcp, które nie wskazuje własnego obszaru roboczego, jest obsługiwane w nim, bez przeszukiwania niczego powyżej. Katalog główny, który nie jest istniejącym folderem — ścieżka niewskazująca niczego albo wskazująca plik — jest odrzucany przez każde polecenie odczytujące swój obszar roboczy, zanim polecenie zrobi cokolwiek innego; aggrega serve i nasłuchujący aggrega mcp odmawiają uruchomienia z takim katalogiem, a aggrega mcp działający przez standardowe wejście i wyjście mimo to się uruchamia i na każde wywołanie działające w tym obszarze roboczym odpowiada odmową. Odmowa wskazuje to z dwóch źródeł, które dostarczyło wartość, --workspace-root lub AGGREGA_WORKSPACE_ROOT, wraz z wartością dokładnie w podanej postaci. Polecenie, które nie odczytuje obszaru roboczego, takie jak aggrega version, nie odczytuje też katalogu głównego i nie jest z jego powodu odrzucane.
Jeśli nie podano żadnego z nich, a wykrywanie niczego nie wyznaczy, katalogiem głównym jest folder, w którym uruchomiono polecenie, a polecenie odczytujące swój obszar roboczy informuje o tym w jednym wierszu na standardowym wyjściu błędów, podając ten folder i tę flagę; zob. Konfiguracja, gdzie wyjaśniono również, dlaczego w takim folderze nic nie jest zapisywane w pamięci podręcznej artefaktów.
Globalny plik konfiguracyjny
--config <path> jawnie wskazuje globalny plik konfiguracyjny dla jednego wywołania. Ma pierwszeństwo przed zmienną środowiskową AGGREGA_CONFIG, która z kolei ma pierwszeństwo przed domyślną lokalizacją — a ponieważ obie wskazują plik celowo, nieistniejąca ścieżka jest głośnym błędem, a nie cichym przejściem do wartości zastępczej. W odróżnieniu od zmiennych ustawień AGGREGA_* żadna z nich nie nadpisuje pojedynczego ustawienia; wybierają one, który plik obowiązuje. Niezależnie od tego, który plik zostanie wybrany, własne pliki konfiguracyjne projektu nadal nakładają się na niego. Konfiguracja opisuje kolejność rozstrzygania i to, co należy umieścić w tym pliku.
--config i zmienna środowiskowa AGGREGA_CONFIG wybierają zarówno cel zapisu, jak i źródło odczytu: polecenie uruchomione z --config <path> odczytuje konfigurację z tego pliku i zapisuje swoją zmianę w tym samym pliku, dzięki czemu to, co polecenie zapisuje, jest tym, co odczyta następne polecenie wywołane w ten sam sposób.
Polecenia modyfikujące konfigurację wybierają plik do zapisu na podstawie charakteru ustawienia: konfiguracja narzędzia obejmująca całą maszynę (rejestr) domyślnie trafia do pliku globalnego, natomiast konfiguracja uczestnicząca w budowaniu (powiązanie dostawcy lub podłączenie gniazda governance/lintera/importera) domyślnie trafia do zatwierdzonego w repozytorium pliku projektu. Aby to zmienić, należy przekazać --global lub --workspace; polecenie wypisuje, gdzie zapisało zmianę.
Aby utworzyć globalną konfigurację na nowej maszynie — rejestrując rejestr i jego politykę zaufania do podpisów, tak aby podpisane artefakty były pobierane i weryfikowane bez ręcznej edycji YAML — należy uruchomić aggrega config init. Aby zobaczyć, co obowiązuje w danej chwili, a z --origin także to, która warstwa zdecydowała o każdym ustawieniu, należy uruchomić aggrega config show.
--offline
Odmawia każdego dostępu do sieci w tym jednym uruchomieniu.
Tryb offline to ustawienie obszaru roboczego, a nie tryb jednego polecenia, i można go włączyć w trzech miejscach: tą flagą, zmienną AGGREGA_OFFLINE oraz kluczem najwyższego poziomu offline w pliku konfiguracyjnym. Oznaczają one to samo i obowiązuje między nimi zwykła kolejność — flaga ma pierwszeństwo przed zmienną, a zmienna przed plikiem.
Wyłączanie jest takim samym zadaniem flagi jak włączanie. --offline=false zezwala na dostęp do sieci dla jednego polecenia tam, gdzie zatwierdzony plik konfiguracyjny lub wyeksportowana zmienna włączyły tryb offline. Ma to znaczenie, gdy nie można samodzielnie edytować pliku: projekt, którego .aggrega-config.yaml zawiera offline: true, odmawia publikacji każdemu, kto go sklonuje, a przekazanie --offline=false jest jedynym rozwiązaniem, które nie wymaga ani commitu, ani wyeksportowanej zmiennej.
Co jest odmawiane, a co nie
Granica wynika z tego, czego wymaga praca, a nie z tego, jakie polecenie wpisano.
Odmawiane, ponieważ nie może być prawdziwe bez dostępu do rejestru:
--upgrade, gdziekolwiek występuje. Ponownie rozwiązuje każdą zależność i podnosi każdą do najwyższej wersji, jaką rejestr aktualnie oferuje, a „najwyższa dostępna” to stwierdzenie o tym, co rejestr udostępnia w tej chwili. Uruchomienie go na wypełnionej pamięci podręcznej przypięłoby to, co akurat się w niej znalazło, jednocześnie raportując podniesienie do najnowszej wersji, co jest gorsze niż zatrzymanie.- Polecenia, których praca sama w sobie polega na komunikacji sieciowej:
aggrega push,aggrega push-artifactorazaggrega registry update. Informują o tym przed odczytaniem encji lub przejściem repozytoriów, a komunikat odmowy wskazuje, które z trzech miejsc włączyło tryb offline, dzięki czemu osoba, która nie wpisała żadnej flagi, wie, gdzie szukać.
Nieodmawiane, ponieważ maszyna może już być w stanie to spełnić:
- Zwykłe
aggrega pullorazaggrega build --auto-pull. Oba respektują już zapisane przypięcia i rozwiązują tylko to, co ich nie ma, więc obszar roboczy, którego wszystkie odwołania znajdują się w pamięci podręcznej lub w katalogucatalog_dirs, kończy pracę bez żadnego dostępu do sieci. Jeśli takie uruchomienie rzeczywiście musi coś pobrać, zostaje odmówione w tym miejscu z informacją, którego odwołania nie udało się spełnić. aggrega buildz wypełnionym plikiem lockfile, który odczytuje całe swoje domknięcie z pamięci podręcznej. Jedynym dostępem do sieci, jaki wykonuje, jest naprawa: gdy kopia przypiętego zewnętrznego wejścia zniknęła z magazynu, to wejście jest pobierane ponownie według skrótu zapisanego już w lockfile. W trybie offline nie ma transportu nawet do tego, więc brakująca kopia zatrzymuje budowanie, wskazując tryb offline.- Publikacja z
--dry-run. Całe jej działanie polega na zaraportowaniu, co zostałoby opublikowane, bez żadnych wywołań, co czyni ją bezpieczną w trybie offline formą publikowania, a nie zaprzeczeniem tego trybu.
Maszyna odizolowana od sieci, przechowująca lokalną kopię swojego katalogu i artefaktów, to przypadek, dla którego istnieje ten podział: taki obszar roboczy jest w trybie offline, a niemal wszystko, co robi, nadal da się spełnić.
Kolejność pierwszeństwa konfiguracji
Flaga ma pierwszeństwo przed wszystkim: przed zmienną środowiskową, przed plikami konfiguracyjnymi i przed wbudowaną wartością domyślną. Pełną hierarchię opisuje strona Konfiguracja, a listę zmiennych z prefiksem AGGREGA_ zawiera environment-variables.md.
aggrega config show --origin pokazuje, która z tych warstw zdecydowała o każdym ustawieniu, a wpisana flaga jest zgłaszana jako flaga — gdy więc odmowa wskazuje nieoczekiwaną warstwę, można to sprawdzić właśnie tym poleceniem.
Zobacz także
- configuration.md — do którego pliku należy dane ustawienie oraz pełny model pierwszeństwa.
- environment-variables.md — pełna dokumentacja zmiennych
AGGREGA_*. - aggrega-serve.md — demon ustala swój obszar roboczy tą samą ścieżką wykrywania katalogu głównego.
| Flaga | Domyślnie | Opis |
|---|---|---|
--config | — | ścieżka do globalnego pliku konfiguracyjnego, nadpisująca zmienną środowiskową AGGREGA_CONFIG i domyślną lokalizację. Pliki konfiguracyjne z drzewa obszaru roboczego nadal są nakładane na wierzch |
--no-color | false | Wyłącza kolory ANSI we wszystkich danych wyjściowych. Respektowana jest również zmienna środowiskowa NO_COLOR |
--offline | false | Odmawia wszelkich połączeń sieciowych w tym jednym uruchomieniu: tryb offline włączony bez edytowania konfiguracji. Aby wyłączyć go na jedno uruchomienie, gdy plik konfiguracyjny lub AGGREGA_OFFLINE już go włącza, należy podać —offline=false. Odmawia działania to, co nie może się udać bez rejestru: —upgrade, którego jedynym zadaniem jest podniesienie każdej zależności do najwyższej wersji obecnie oferowanej przez rejestr, oraz polecenia, których praca sama w sobie jest komunikacją sieciową — push, push-artifact i registry update. Nadal działa wszystko, co maszyna może już obsłużyć: kompilacja na podstawie wypełnionego pliku blokady, —auto-pull dla odwołań już zbuforowanych lub obecnych w lokalnym katalogu oraz przebieg próbny (dry run), który raportuje, co by opublikował, i niczego nie wywołuje |
--plain | false | Tryb dostępności: wyłącza kolory i rysuje proste, statyczne wiersze postępu bez animacji wskaźnika ani odświeżania kursora, nawet w terminalu. Przeznaczony dla czytników ekranu |
--workspace-root | — | ścieżka bezwzględna używana jako katalog główny obszaru roboczego (pomija wykrywanie) |