Rendered from docs/interfaces/consumer-surface.md in the Headwater corpus. Every document on this half of the site is typed by the taxonomy the descriptor names: corpus.json.

The consumer surface

This page lists what an adopter receives, what an adopter runs, and what an adopter must have installed. headwater generate writes it from the surface block of the taxonomy, and headwater generate --check reports it stale when the block changes.

What the archive holds

The files of a release archive, as paths inside it.

  • headwater
  • LICENSE

What the Debian package installs

The paths the .deb package writes on the host that installs it. The package holds no taxonomy, and no maintainer script reads or writes a corpus.

  • /usr/bin/headwater
  • /usr/share/doc/headwater/copyright
  • /usr/share/bash-completion/completions/headwater
  • /usr/share/zsh/vendor-completions/_headwater
  • /usr/share/fish/vendor_completions.d/headwater.fish

Integration points

The places where an adopter connects the binary, and what each one needs beyond the binary.

Integration point What it needs beyond the binary
agent_harness nothing
ci_forge nothing
git git, sh
shell sh
site_generator mkdocs, python3

Prerequisites

Programs that an adopter installs and that this project does not supply.

  • git
  • sh
  • curl
  • tar

Companions

Tools that an adopter may run and that no conformance level requires.

  • headwater probe
  • headwater neighbors
  • headwater sweep

Commands

The first word of every command that a page for an adopter may tell a reader to run.

  • headwater
  • git
  • sh
  • curl
  • tar
  • cd
  • echo
  • grep
  • mkdir
  • printf
  • rm
  • wc
  • xargs
  • uname
  • python3
  • mkdocs
  • apt-get
  • sudo
  • install
  • tee

The block also names the pages for an adopter and the roots that only this repository holds. They configure the check that holds each such page, and they are not something an adopter receives or runs, so this page does not list them.