Přeskočit na obsah

Tato stránka byla automaticky přeložena z angličtiny, jediného jazyka, ve kterém se tento web píše. Číst originál.

HTTP API: shell

Shellová automatizace repozitáře změřená proti sledovanému inventáři migrace: nový shell se odmítne, pokud výjimka nedeklaruje, proč musí být shell a kdy přestane být, a odmítne se i výjimka, jejíž soubor zmizel, takže seznam se jen zmenšuje, jak se jednotky přesouvají do typovaných a skriptovaných schopností (ADR 0069).

Vykresleno z docs/generated/openapi.json, který spustitelný soubor generuje ze svého registru schopností a CI jej odmítne, je-li zastaralý. Surový dokument je na /openapi.json; běžící server servíruje stejný dokument na vlastní /openapi.json a Swagger UI na /swagger.

shell

Shellová automatizace repozitáře změřená proti sledovanému inventáři migrace: nový shell se odmítne, pokud výjimka nedeklaruje, proč musí být shell a kdy přestane být, a odmítne se i výjimka, jejíž soubor zmizel, takže seznam se jen zmenšuje, jak se jednotky přesouvají do typovaných a skriptovaných schopností (ADR 0069).

GET /api/v1/shell/check shell.check

Odmítnout nedeklarovaný shell

Každá shellová jednotka pod bin/, lib/, scripts/, share/, .githooks/ a .claude/hooks/ — podle řádku interpretu nebo názvu .sh, tak jak by ji commitoval git, odkazy se nesledují — proti .ai/repo/automation/inventory.jsonl: nedeklarovaná jednotka, záznam, jehož jednotka zmizela, výjimka bez důvodu nebo podmínky odstranění, dispozice mimo A-F, duplikát a záznam mimo kanonické pořadí jsou každé zjištění, které pojmenovává soubor a nápravu. Čte jen strom a index gitu; žádný build a žádná síť.

  • query
  • behaviorally_verified
  • vyžaduje se měření výkonu
  • cache vypnuta
  • Nástroj MCP majordomus_shell_check
  • $ shell check

Žádné parametry.

Vyzkoušejte

Port je ten, který server zalogoval; 8741 je ten, o který žádá jako první. Hodnoty jsou první příklad operace.

curl -s "http://127.0.0.1:8741/api/v1/shell/check"

Testováno v apps/majordomus-cli/tests/http_serve.rs, který přehrává routu s těmito hodnotami proti serveru na skutečném socketu.

Odpovědi

statustělovýznam
200 ShellReport Odmítnout nedeklarovaný shell: výsledek.
400 ErrorBody invalid_input: Vstup neodpovídá schématu: parametr špatného typu, neznámý parametr nebo hodnota, kterou schopnost odmítne.
404 ErrorBody not_found: Vstup pojmenovává něco, co repozitář nemá.
500 ErrorBody internal: Schopnost selhala z vlastního důvodu; zpráva ho pojmenovává.
výchozí ErrorBody Jakékoli jiné selhání, které transport hlásí: 405 method_not_allowed pro jinou metodu na této cestě, 400 invalid_input pro tělo, které není objektem JSON.

Schémata

Komponenty, které používají jen operace tohoto tagu. Každý řádek je pole daného typu, jeho doc komentář je popis; typ vlastněný jinou stránkou na ni odkazuje.

ShellFinding

object
Jedna věc, kterou kontrola odmítá, s tím, co s ní dělat.
vlastnosttyppovinnépopis
kód string ano Kód nálezu: shell.undeclared, shell.stale, shell.missing_field, shell.invalid_disposition, shell.invalid_unit, shell.exemption_not_shell, shell.duplicate, shell.out_of_order nebo shell.malformed.
path string ano Soubor, kterého se zjištění týká: shellová jednotka, nebo samotný inventář.
řádek integer | null ne Řádek soupisu, kterého se nález týká, pokud se týká jednoho.
zpráva string ano Co je špatně, jednou větou.
náprava string ano Co s tím dělat.

Používá ShellReport

ShellReport

object
Verdikt jedné kontroly stromu.
vlastnosttyppovinnépopis
naměřeno boolean ano Zda se strom vůbec dal změřit. false není úspěch: důvod říká, co měření zastavilo, a volající, který se na tuto zprávu podmiňuje, musí odmítnout.
důvod string | null ne Proč se strom nedal změřit, když se nedal.
inventář string ano Přečtený inventář, relativně ke kořeni repozitáře.
řízeno array of string ano Adresáře, jejichž shellové jednotky se musí deklarovat.
jednotky pole ShellUnit → ShellUnit ano Každá shellová jednotka pod řízenými adresáři v kanonickém pořadí.
records integer (uint) ano Kolik záznamů inventář drží, shellových či nikoli.
výjimky mapa celých čísel (uint) ano Kolik výjimek inventář deklaruje, podle dispozice.
zjištění pole ShellFinding → ShellFinding ano Každý nález v kanonickém pořadí. Prázdný seznam je úspěšná odpověď.
průchody boolean ano true, když byl strom změřen a nic se nenašlo.

Používá shell.check

ShellUnit

object
Jedna shell jednotka, kterou strom nese.
vlastnosttyppovinnépopis
path string ano Cesta relativní ke kořeni repozitáře.
dialekt string ano Shell, pro který je jednotka psána: interpret, který jmenuje její první řádek, nebo sourced pro soubor *.sh bez řádku interpretu.
dispozice string | null ne Dispozice, kterou nese jeho záznam v inventáři, pokud ho má.

Používá ShellReport

Prohledává názvy a popisy všech stránek, které tento web publikuje.