majordomus executions protocol
Smlouva živého kanálu: kde je, co zapisuje a schéma každé zprávy
majordomus executions protocol
Použití
majordomus executions protocol [OPTIONS]Argumenty
| argument | hodnota | výchozí | popis |
|---|---|---|---|
| --repo | <PATH> | — | Zde začne hledání kořene repozitáře (výchozí: aktuální adresář) (přijímá každý podpříkaz) |
| --discovery | vcs | filesystem | vcs | Jak se vyhledávají deklarativní soubory (přijímá každý podpříkaz)
|
| --strict | flag | — | Odmítne pokračovat, pokud kterýkoli soubor vrstvy nese diagnostiku typu chyba (přijímá každý podpříkaz) |
| --share | <DIR> | — | Adresář share distribuce nástroje (kinds.yaml, schemas/); výchozí: $MAJORDOMUS_SHARE, poté vlastní share/ repozitáře, poté ten vedle spustitelného souboru (přijímá každý podpříkaz) |
| --format | text | json | text | Tvar výstupu (přijímá každý podpříkaz)
|
Příklady
-
Kontrakt živého kanálu z typů, které jej implementují
Kde je WebSocket, jak se vyjadřuje odběr a opětovné připojení, každý typ zprávy a JSON Schema každého — odvozeno z typů Rustu, takže klient validující proti tomuto validuje proti implementaci. OpenAPI nedokáže popsat socket, a proto je to schopnost, ne odstavec.
$ majordomus executions protocol --format jsonCo tvrdí: skončí kódem 0; vypíše jeden dokument JSON nesoucí /protocol_version, /websocket, /event_types/0, /stream_types/0, /limits/max_events.
Testuje apps/majordomus-cli/tests/cli_examples.rs, který spouští příkaz nad sestaveným programem a ověřuje, co stránka uvádí.
Odkud to pochází
Deklarováno jednou v apps/majordomus-cli/src/cli.rs: clap pro strukturu, typovaná metadata v Rustu vedle něj pro příklady. Tato stránka, majordomus executions protocol --help, docs/generated/cli.md a docs/generated/cli.json jsou projekce této jediné deklarace.
Celá příkazová řádka na jedné stránce: stránka příkazové řádky registru. Životní cyklus úlohy (init, start, finish, doctor, ...) patří nástroji shell, jinému programu: Příkazy a jeho specifikace.