CLI reference / quality / hooks / install

stado quality hooks install

Invocation

stado quality hooks install [OPTIONS]

Purpose

Write Stado's pre-push hook into each checkout whose hooks Git runs from its own hooks directory, or repair one another Stado wrote; a hook that is there already and is not Stado's is kept as pre-push.chained and runs after the gate. Running it again changes nothing. A checkout whose core.hooksPath sends Git elsewhere is left and named. Exits non-zero, after every checkout was taken, when one could not be read or written

Required inputs and options

Input or optionContract
--product <PRODUCT>The catalogued product whose checkouts are taken: the canonical checkout of its owner repository and of every surface's and installation's repository
--allEvery catalogued product's checkouts
--jsonOne document on stdout: each checkout's repository, products, path, hooks directory, state, whether an earlier hook is chained and what the verb did

Output and state effect

It performs the operation described above and emits its operator result on standard output or standard error. Any state change is limited to the resources and records named by the purpose and options on this page.

Refusals

  • Before dispatch, Stado refuses a missing required token shown in the invocation, an unknown option, or a value outside a listed value set; argument-usage failures exit with code 2.