Skip to content

The documented one-line install command is composed from the model's parts, and a document that states a different one fails the suite

The command a person pastes is not a string anybody typed into a document. It is four

guaranteed Deterministic and blocking. Implemented, and a behavioural test proves it.

The download command, the base URL, the script name and the shell are four fields; the command is their composition. README.md and the installation guide are checked against it rather than trusted.

What it means

The command a person pastes is not a string anybody typed into a document. It is four fields of share/distribution.yaml — the download command, the base URL, the script's name and the shell — composed in one place:

{download_command} {base_url}/{script} | {shell}

README.md, docs/INSTALL.md, the landing page, the getting-started page and the installer's own help text all show that composition. The website and the guide are generated from it; the README is checked against it.

How it works

Model::install_command composes it, majordomus distribution show answers it, and site/data/registry/distribution.json carries it for the templates. The behavioural case test/cases/84_distribution_model.sh asks the model for the command and requires it to appear verbatim in README.md and in the installation guide.

How to see it

majordomus distribution show --format json | grep install_command
bash test/run.sh 84_distribution_model

What it does not cover

The prose around the command is written by people and is not generated. What is guaranteed is that the command itself cannot quietly differ between the README, the guide and the website — including after the base URL or the script's name changes.

Why it exists

A typo in an installation command is a uniquely expensive documentation bug: it fails for every reader, it fails at the first thing they try, and it is invisible to whoever wrote it because they never paste it. Deriving it makes the typo impossible; checking the one document that is not derived makes it fail the suite instead of the reader.

Detail rendered from docs/claims/install-command-is-derived.md.

Provenance

defined in
read it on this site · docs/INSTALL.md
implemented in
apps/majordomus-cli/src/distribution/mod.rs
proved by
test/cases/84_distribution_model.sh
claim id
install-command-is-derived

Verify it yourself

The test runs in a disposable temporary repository and asserts the behaviour, not a string in the source.

from a clone of the repository
bash test/run.sh 84_distribution_model

Where this claim is used

responsibilities it covers

Related claims same implementation