aggrega config
Çalışma alanı yapılandırmasını inceler ve yönetir
Kullanım
aggrega configAçıklama
Inspect and manage the configuration Aggrega reads.
Most projects need two files.
One .aggrega-config.yaml at your project root, carrying a "workspace:" block —that block is what marks the root — holds how this project builds: its catalogdirectories, its provider bindings, which lint rules it relaxes. It iscommitted, so a teammate who clones the project builds it the same way.
One global file is shared across every workspace on this machine:~/.config/aggrega/config.yaml, or on Windows aggrega\config.yaml inside thedirectory the APPDATA environment variable names. It holds what belongs to themachine rather than to any one project: the registries you pull from and thesignature trust policy for each, how large the compiled-module store may grow,any command extension you have installed. It loads automatically when it isthere, and nothing breaks when it is not.
Your project's file wins over the global one, an environment variable winsover both, and a flag wins over everything.
Secrets are not configuration. A registry password or a signing identity tokenis never a field in either file; it is supplied by environment variable or flagat the moment it is needed.
Because the effective configuration is assembled rather than written anywhere,"aggrega config show" is how you see what actually applies, and --origin is howyou find out which layer each setting came from. "aggrega config init" seeds aworking configuration, and "aggrega config capture" freezes the effectivebuild-critical settings into this workspace so a build does not depend on aglobal file that is not committed.
Larger projects have more to work with. None of it is needed to start, and eachpiece exists for the shape it solves:
More than one file inside a project. Every .aggrega-config.yaml from the project root down to the directory you run in contributes, a nearer file overriding a farther one. Only a file carrying "workspace:" marks the root; one without it contributes settings without anchoring anything.
Extending a list instead of replacing it. A nearer file's list replaces the farther one's. The companions catalog_dirs_append, governance_append, linter_append, importer_append and providers_append concatenate onto the resolved list at each layer instead of shadowing it.
A file your pipeline owns. .aggrega-config-append-ci.yaml may sit beside the hand-authored file in any of those directories, so automation can overwrite it wholesale without touching what a person wrote. It is additive only: it removes nothing and overrides no scalar, and a scalar key written in it is ignored and named in a warning. It never marks a root.
A relative path anchors to the file that declared it. A catalog directory, a local plugin path, or an entry under a plugin's with.sources resolves against the directory of the config file it was written in — not the project root, and not the directory you ran the command from. So the same "./catalog" names a different directory depending on which file carries it. Two settings sit outside this rule: artifact_cache_dir is interpreted relative to the project root wherever you run from, and AGGREGA_CATALOG_DIRS has no declaring file at all, so supply absolute paths in it.
The other root markers. A "workspace:" block wins outright at whatever depth it sits. Failing one, the nearest .aggrega/ directory or aggregate*.yaml, release*.yaml or manifest*.yaml file anchors the root, in that order within a directory; failing everything, your working directory is used. --workspace-root skips discovery entirely.
Naming the global file. --config <path> wins over the AGGREGA_CONFIG environment variable, which wins over the default location. Both name a file deliberately, so a path either gives that does not exist is a loud error rather than a silent fallback. Whichever file resolves is also the one a config-writing command writes when it writes globally.Alt komutlar
| Komut | Açıklama |
|---|---|
aggrega config capture | Etkin, derleme açısından kritik yapılandırmayı bu çalışma alanına dondurur |
aggrega config init | Bir kayıt defteri ve onun güven politikasıyla çalışan bir yapılandırma oluşturur |
aggrega config show | Etkin yapılandırmayı ve her ayarın nereden geldiğini gösterir |
aggrega config capture açıklaması
Write the effective build-critical configuration into this project's workspaceconfig file, so the workspace builds identically without relying on themachine's global configuration.
The build-critical subset is the configuration a build participates in: a set ofplugin socket attachments and the catalog directories. By default the capturedsockets are only those that determine therendered output — the provider bindings and the transform-role governance attachments — since only those musttravel with the project for byte-identical output. Pass --all-plugins to alsofreeze the verdict-role governance, linter, and importer sockets, which otherwise stay free tovary by environment. Each field is written at its effective value — the valuethat resolves right now with the global configuration and the workspace treemerged together — so a binding that today comes only from the global config ismaterialized into the workspace and travels with the project.
Machine-wide tooling settings, such as a registry's trust policy, are notcaptured: they stay in the global config by their nature. Capture always writesthis project's workspace config file. Running it again on an unchangedconfiguration rewrites the same file byte-for-byte. Run in a folder that is notinside a workspace, with no --workspace-root naming one, it writes nothing andexits with an error saying so.aggrega config capture bayrakları
| Bayrak | Varsayılan | Açıklama |
|---|---|---|
--all-plugins | false | Karar rolündeki yönetişim, linter ve içe aktarıcı kapıları dahil tüm plugin soketlerini yakalar. Bu olmadan capture yalnızca işlenmiş çıktıyı belirleyen soketleri (provider bağlamaları ve dönüştürme rolündeki yönetişim ekleri) dondurur. |
aggrega config init açıklaması
Seed a working configuration by registering a registry and its signature trustpolicy, so a fresh machine can pull and verify signed artifacts without editingYAML by hand.
By default it registers the official hub (hub.aggrega.ai) with signaturesrequired and the official trusted identities. The registry's advertised trustpolicy is fetched once from its own origin and pinned locally — trust-on-first-use; when the hub is unreachable, advertises nothing, or the workspace isoffline, its built-in official baseline is written instead, so init stillproduces a usable config offline. Pass --registry to seed a different registry(for an air-gapped or private hub). Such a registry has no built-in baseline,so seeding it while the workspace is offline is refused: init takes noidentities or key to pin by hand, so register it once while online, or add itwith "aggrega registry add --identity" or "--key".
The entry is written to the global config shared across every workspace bydefault; pass --workspace to write it to this project's workspace configinstead. If the target config file already exists, init refuses rather thanoverwrite it — pass --force to write anyway (the registry entry is merged intothe existing file, other settings preserved).
Before anything else, init says where things are: the configuration file itcreated — or, under --force, the one already there that it wrote into — andthe directory the machine-wide caches are kept in. On Windows that directory isaggrega\cache inside the directory the LOCALAPPDATA environment variable names;elsewhere it is a directory named aggrega under the per-user cache directory:~/.cache/aggrega on Linux unless XDG_CACHE_HOME names another, and~/Library/Caches/aggrega on macOS.
A seeded configuration is a document you own and go on editing, so --dry-run doeseverything init does except write: it hands the content back, creating andmodifying nothing. The answer names the file the content is for — which mattershere, because the target is the global config unless --workspace selects thisproject's own. A caller that keeps its own document model puts the content there,where it is visible before it is saved and can be amended or undone. The registryis still contacted for its advertised trust policy, because the policy in thatcontent is the policy a write would have pinned.
Because a dry run does everything else init does, it refuses an existing configfile exactly as a write refuses it, and for the same reason. So its exit codepredicts the write's: if the dry run refuses, init would have refused. Pass--force alongside it to see the merge an overwriting write would produce.
Under --dry-run standard output carries that content and nothing else, so it staysparseable. A registry seeded with no trust policy, because it advertises none,still produces its notice, on standard error: read that stream too, or thatconfiguration arrives without the advice to pin identities by hand. A pinnedpolicy, whether advertised or the hub's built-in baseline, is in the contentitself and produces no notice.aggrega config init bayrakları
| Bayrak | Varsayılan | Açıklama |
|---|---|---|
--dry-run | false | Yazma dışında her şeyi yapar: oluşturulan yapılandırmayı, hangi dosya için olduğunu belirterek içerik olarak geri verir ve hiçbir şey oluşturmaz ya da değiştirmez. Diğer tüm davranışlar yazmanınkiyle aynıdır; bu nedenle mevcut bir yapılandırma dosyası, yazmanın reddettiği gibi aynen reddedilir — üzerine yazan bir yazmanın üreteceği birleştirmeyi görmek için yanında —force geçirin. |
--force | false | Mevcut bir yapılandırma dosyasının üzerine yazar. Bu olmadan init, hedef dosya zaten varsa reddeder. |
--global | false | Girdiyi tüm çalışma alanlarınca paylaşılan genel yapılandırmaya yazar. Varsayılan budur. |
--registry | hub.aggrega.ai | Güven politikasıyla birlikte eklenecek kayıt defteri sunucusu. Varsayılan olarak resmi hub’dır. |
--workspace | false | Girdiyi genel yapılandırma yerine bu projenin çalışma alanı yapılandırmasına yazar. |
aggrega config show açıklaması
Show the configuration that applies right now.
By default it leads with the cascade of config files and environment overridesthat contributed, lowest precedence first, then prints the effective mergedconfiguration — the global config, the workspace-tree cascade, and anyenvironment override combined into what applies right now.
Pass --global or --workspace to print a single layer's own file bytes verbatim,preserving its comments and formatting; when that layer's file does not exist itsays so rather than failing. The two are mutually exclusive.
Pass --origin to annotate each effective setting with the layer it came from —a command-line flag, an environment variable, a config file, or the built-indefaults, highest precedence first. A flag is named as the reader typed it, soa setting a flag decided reports that flag as its source. A setting isattributed to the highest-precedence layer that sets it, whatever value thatlayer writes: a file restating the default is the file named, not the built-indefaults. List and map settings are attributed as a whole. The signingrequirement is the one exception: any layer may turn it on and none can turn itoff, so it names the first layer that turns it on.aggrega config show bayrakları
| Bayrak | Varsayılan | Açıklama |
|---|---|---|
--global | false | Genel yapılandırma dosyasının kendi baytlarını, yorumlarını ve biçimlendirmesini koruyarak olduğu gibi yazdırır. |
--origin | false | Her etkin ayara geldiği katmanı (bir komut satırı bayrağı, bir ortam değişkeni, bir yapılandırma dosyası veya yerleşik varsayılanlar) not olarak ekler. |
--workspace | false | Bu projenin çalışma alanı yapılandırma dosyasının kendi baytlarını, yorumlarını ve biçimlendirmesini koruyarak olduğu gibi yazdırır. |
Ne yapar
config alt komutları, bir derlemeyi yöneten yapılandırmayı oluşturur, inceler ve dondurur. Bir ayarın hangi dosyaya ait olduğu ve katmanların nasıl birleştiği için Yapılandırma sayfasına bakın; bu sayfa çoğu projenin ihtiyaç duyduğu iki dosyayla başlar ve geri kalanını bunların arkasında tutar.
config init — çalışan bir yapılandırma oluşturma
aggrega config init, yeni bir makinede bir kayıt defterini ve onun imza güven politikasını kaydederek bir yapılandırma oluşturur; böylece imzalı yapıtlar YAML elle düzenlenmeden çekilir ve doğrulanır. Varsayılan olarak resmi hub’ı (hub.aggrega.ai) imzalar zorunlu olacak şekilde ve resmi güvenilir kimlikleriyle kaydeder. Kayıt defterinin duyurduğu güven politikası kendi kaynağından bir kez alınır ve yerel olarak sabitlenir (ilk kullanımda güven); hub’a ulaşılamadığında, hiçbir şey duyurmadığında ya da çalışma alanı çevrimdışı olduğunda bunun yerine yerleşik resmi temel politika yazılır, böylece init çevrimdışıyken de kullanılabilir bir yapılandırma üretir.
init, her şeyden önce nesnelerin nerede olduğunu söyler. Yeni bir Linux makinesinde oluşturma şöyle başlar:
Created the global configuration file at /home/you/.config/aggrega/config.yamlMachine-wide caches are kept in /home/you/.cache/aggregayeni bir Windows makinesinde ise şöyle:
Created the global configuration file at C:\Users\you\AppData\Roaming\aggrega\config.yamlMachine-wide caches are kept in C:\Users\you\AppData\Local\aggrega\cacheİlk satır, init’in yazdığı yapılandırma dosyasını adlandırır: dosya yoksa Created, varsa ve --force, init’in ona yazmasına izin verdiyse Using; --workspace altında genel dosya yerine çalışma alanı yapılandırma dosyasını adlandırır. İkinci satır, makine genelindeki önbelleklerin (derlenmiş eklentiler ve açıklamaları) tutulduğu dizini adlandırır; bu, her platformun bir kullanıcının önbelleklerini tuttuğu yerdir; platforma göre kural için Hangi önbellekler bu projeye, hangileri makineye aittir bölümüne bakın. Her satır yolu ile biter ve ardından hiçbir şey gelmez, böylece yol olduğu gibi kopyalanabilir. Sonraki satırlar kaydın kendisine aittir: güven politikası alımının ne bulduğu ve kayıt defterinin hangi dosyaya kaydedildiği. Reddedilen bir oluşturma hiçbir şey yaratmadığı için bu satırların hiçbirini yazdırmaz; standart çıktısı yalnızca geri verdiği içeriği taşıyan --dry-run da yazdırmaz.
--registry <host>, resmi kayıt defteri yerine farklı bir kayıt defterini (ağdan yalıtılmış veya özel bir hub) oluşturur. Böyle bir kayıt defterinin yerleşik temel politikası yoktur; bu nedenle hiçbir şey duyurmadığında girdi politikasız yazılır ve çevrimdışı bir çalışma alanında oluşturulması reddedilir (kısa kodE0310): politika alınamaz veinit, birini elle sabitlemek için--identityveya--keyalmaz. Bunu çevrimiçiyken bir kez oluşturun ya daaggrega registry addve sağladığınız bir politikayla ekleyin.- Hedef dosya zaten varsa
initüzerine yazmak yerine reddeder;--forceyine de yazar, kayıt defteri girdisini mevcut dosyaya birleştirir ve diğer ayarları korur. --dry-run, yazma dışındainit’in yaptığı her şeyi yapar. Oluşturulan yapılandırmayı içerik olarak geri verir, hiçbir şey yaratmaz ve değiştirmez; yanıt, içeriğin hangi dosya için olduğunu adlandırır. Bu burada önemlidir, çünkü--workspacebu projenin kendi dosyasını seçmedikçe hedef genel yapılandırmadır. Bir düzenleyici gibi kendi belge modelini tutan bir çağıran, içeriği oraya koyar; orada kaydedilmeden önce görünür olur, değiştirilebilir veya geri alınabilir.- Deneme çalıştırması
init’in yaptığı diğer her şeyi yaptığı için çıkış kodu yazmanınkini öngörür. Mevcut bir yapılandırma dosyasını, bir yazmanın reddettiği gibi ve aynı nedenle reddeder; böylece değişikliği uygulamadan önceinit’in başarılı olup olmayacağını sormak için kullanabilirsiniz. Üzerine yazan bir yazmanın üreteceği belgeyi görmek için yanına--forceekleyin:--force --dry-runbirleştirmeyi raporlar ve yine hiçbir şey yazmaz. - Duyurulan güven politikası için kayıt defterine yine de başvurulur, çünkü raporlanan içerikteki politika, bir yazmanın sabitleyeceği politikadır. Deneme çalıştırması, o kayıt defterinin kendi kaynağına bir yazmanın yaptığı aynı tek kimlik doğrulamasız isteği yapar.
--dry-runaltında standart çıktı yalnızca o içeriği taşır, böylece ayrıştırılabilir kalır. İçeriğin ifade edemediği tek şey bir yokluktur: bir kayıt defteri hiçbir güven politikası duyurmadığında ve politikasız oluşturulduğunda, bunu bildiren ve kimlikleri--identityveya--keyile sabitlemenizi söyleyen uyarı standart hataya gider. Güvenilir kimlik içermeyen bir yapılandırma belgesi, bir politika sabitlenip boş çıkmış olsa da hiç politika duyurulmamış olsa da aynı görünür; bu nedenle her iki akışı da okuyun; standart hatayı atan bir program bu konuda hiçbir şey öğrenmez. Kayıt defteri bir politika duyurduğunda ya da onun yerine resmi hub’ın yerleşik temel politikası sabitlendiğinde, sabitlenen politika raporlanan içeriğin kendisindedir ve ayrı bir uyarı üretilmez.
Oluşturulan bir yapılandırma, sahibi olduğunuz ve düzenlemeye devam ettiğiniz bir belgedir; bu yüzden yazılmak yerine geri verilebilir. Aşağıda anlatılan etkin yapılandırmanın dondurulması ise yapılandırmanın neye çözümlendiğinin bir kaydını üretir (birinin oluşturduğu içerik değil, derleyicinin kendisi hakkında tuttuğu durum); bu yüzden her zaman yazar ve --dry-run sunmaz.
config show — şu anda geçerli olanı inceleme
aggrega config show, şu anda geçerli olan yapılandırmayı raporlar. Varsayılan görünümünde katkıda bulunan yapılandırma dosyaları ve ortam geçersiz kılmalarının basamağıyla, en düşük öncelikli olandan başlayarak açılır, ardından etkin birleştirilmiş yapılandırmayı yazdırır: genel yapılandırma, çalışma alanı ağacı basamağı ve varsa ortam katmanı tek bir sonuçta birleştirilmiş olarak. Hangi dosyaların ve ortam geçersiz kılmalarının mevcut yapılandırmayı şekillendirdiğini bu yüklenen dosya basamağında doğrularsınız.
İki odaklı görünüm çıktıyı daraltır:
--globalveya--workspace, tek bir katmanın kendi dosya baytlarını yorumları ve biçimlendirmesi korunarak olduğu gibi yazdırır; o katmanın dosyası yoksa başarısız olmak yerine bunu söyler. İkisi birbirini dışlar.--origin, her etkin ayarı geldiği katmanla işaretler: bir komut satırı bayrağı, bir ortam değişkeni, bir yapılandırma dosyası veya yerleşik varsayılanlar; en yüksek öncelikli olan önce gelir. Bir bayrak yazdığınız şekliyle adlandırılır; böylece bu çalıştırmada--offline’ın belirlediği bir ayar kaynağı olarak--offline’ı raporlar; bir ortam değişkenienv:önekinin ardından, bir yapılandırma dosyası ise mutlak yoluyla adlandırılır.
--origin altında bir ayar, o katman hangi değeri yazarsa yazsın, onu belirleyen en yüksek öncelikli katmana atfedilir. Bu yüzden default_registry: hub.aggrega.ai yazan bir proje dosyası, yerleşik varsayılan aynı kayıt defteri olsa bile o ayar için adlandırılır; genel dosyanın zaten belirlediği bir değeri yineleyen bir proje dosyası da genel dosya yerine adlandırılır: her iki durumda da değeri yerinde tutan dosya odur ve varsayılan ya da altındaki dosya değiştiği gün kaldırılması yanıtı değiştiren de odur. Hiçbir katmanın belirlemediği bir ayar yerleşik varsayılanları raporlar.
- Neyin ayarı belirlemek sayıldığı. Bir yapılandırma dosyası, o ayarın anahtarını taşıdığında bir ayarı belirler; bir liste ayarını ise listenin
_appendeşlikçisini taşıdığında da belirler. Bir ortam değişkeni boş olmayan bir değerle dışa aktarıldığında ayarını belirler, bir bayrak ise onu yazdığınızda:--offline=false, duruşu--offlinekadar kesin biçimde belirler. - İşlem hattınızın sahip olduğu bir yapılandırma dosyası yalnızca okunduğu anahtarlar, yani liste eklemeleri ve imzalama politikası için adlandırılır. Yok saydığı ve hakkında uyardığı bir anahtar hiçbir zaman bir değerin geldiği yer olarak raporlanmaz.
- Liste ve eşlem ayarları bir bütün olarak, onları belirleyen en yüksek öncelikli katmana atfedilir; bir listenin hangi girdisine hangi katmanın katkıda bulunduğu raporlanmaz.
- İmzalama gereksinimi tek istisnadır. Herhangi bir katman onu açabilir ve hiçbiri kapatamaz; bu yüzden onu açan ilk katmanı adlandırır.
required: falseyazan bir katman hiçbir şeyi açmaz; bu nedenle hiçbir katman onu açmadığında ayar yerleşik varsayılanları raporlar.
config capture — derleme için kritik ayarları dondurma
aggrega config capture, derleme için kritik olan etkin yapılandırmayı bu projenin çalışma alanı yapılandırma dosyasına yazar; böylece çalışma alanı, makinenin genel yapılandırmasına dayanmadan aynı şekilde derlenir. Bir kayıt defterinin güven politikası gibi makine genelindeki araç ayarları yakalanmaz; bunlar doğaları gereği genel yapılandırmada kalır. Değişmemiş bir yapılandırmada komut yeniden çalıştırıldığında aynı dosya bayt bayt aynı biçimde yeniden yazılır.
Yakalanan alt küme, bir dizi eklenti soketi bağlantısı ile katalog dizinlerinden oluşur:
- Varsayılan olarak yakalama yalnızca işlenen çıktıyı belirleyen soketleri — sağlayıcı bağlamalarını ve dönüştürme rolündeki yönetişim bağlantılarını — dondurur; çünkü bayt düzeyinde aynı derlemeler için yalnızca bunların projeyle birlikte taşınması gerekir. Katalog dizinleri her zaman yakalanır.
--all-plugins, yakalanan soketleri karar rolündeki yönetişim, linter ve içe aktarıcı soketlerini de kapsayacak şekilde genişletir. Bu seçenek olmadan bu üç soket ortama göre değişmekte serbest kalır.
Yakalama her zaman yazar ve bunun yerine içeriğin geri verilmesi için bir yol sunmaz. Ürettiği şey, yapılandırmanın neye çözümlendiğinin bir kaydıdır, kimsenin oluşturduğu bir belge değildir; bu nedenle bir yazarın gözden geçirip değiştireceği bir şey yoktur — bunu raporlamak, bir çözümlemenin anlık görüntüsünü düzenlemeye davetiye çıkarır.
Yakalama yalnızca bir çalışma alanının içine yazar. Bir çalışma alanının içinde olmayan bir klasörde, birini adlandıran bir --workspace-root ya da AGGREGA_WORKSPACE_ROOT olmadan çalıştırıldığında hiçbir şey yazmaz — oraya yazılan bir yapılandırma dosyası klasörü bir çalışma alanına dönüştürürdü — ve bunu belirten bir hatayla çıkar. aggrega config init --workspace önce klasörü bir çalışma alanı yapar.
Ayrıca bakınız
- configuration.md — bir ayarın hangi dosyaya ait olduğu, öncelik sıralaması ve daha büyük bir projenin başvurduğu mekanizmalar.
- global-flags.md —
--configve--workspace-rootbayrakları. - environment-variables.md — yapılandırmayı çalışma zamanında geçersiz kılan
AGGREGA_*değişkenleri. - aggrega-registry.md — kayıt defterlerini ve bunların güven politikasını doğrudan yönetin.
- aggrega-cache.md —
artifact_cache_dir’in adını verdiği dizinin gerçekte ne barındırdığı ve orada duran ancak hiçbir kilit dosyasının sabitlemediği bir varlığın neden bir derleme tarafından bulunmadığı.