Reference beyond the README ’s walkthrough. Each fact has one home, the doc named for it below, and every other page links there.
Doc Covers Getting started What hi is, the words these docs use, a starting path for a first install, for a dotfiles repo, and for a minimal one, and installing without a terminal. Usage Every hi --flag with an example and a picture of what it prints, generated from common/flags. Settings The wizard, presets, and the config overlay: every toggle and environment variable hi reads. Integrations The tools hi wires in where a target has them: your prompt program, mise, direnv, bat, eza, tmux, and the rest. Colors The per-host hash, the pins, the 24-bit scheme, and the package check’s ramp and rows. Compatibility Every target, OS, and shell hi answers to, and every runtime, shell, and feature answered no , and why. Packaging The install channels, verifying a release download, and what a package leaves for you to do. Troubleshooting Symptom, cause, and fix: installing, your own machine, connecting, and inside a session. Getting help Where to ask a question or file a bug, what to include, what response to expect, and the changes already turned down, with the reasons. Security policy The threat model, what hi touches on a target, supported versions, and how to report a vulnerability. Man page man hi: every flag, setting, and exit status; hi --help is its short form. A roff page, so not on the site. tldr page The eight-example draft for tldr-pages, kept in step with common/flags by the lint gate. Not on the site either.
Doc Covers How it works The architecture: client to transport to target session, how the payload is built and armored, and cleanup. What runs where is the trust-boundary view. Files Every file say-hi is made of, reads, recognizes, and creates: on your machine, on a target, and in a package. Where state lives. Alternatives sshrc, xxh, kyrat, sshdot, and homeshick side by side, and the adjacent tools hi composes with. Glossary The named idioms the code’s GLOSSARY: tags point at; drift-checked by the lint suite. Never ships.
Doc Covers Contributing The gate, what CI runs, what a review bounces on, what 1.x will not break, which docs change with what, AI-assisted contributions, push protection. Testing The runner, suite groups, parallel cases, coverage, the test images, the lint gate, test levers, relaying. Portable spellings How to write a command so every target runs it - sed, grep, awk, pipes under strict mode, bash 3.2, Git Bash - and what catches each slip. Releasing The maintainer’s runbook: channels not shipped, cutting a release, the release environment, publishing each channel, reproducibility, the demo GIFs. Governance Who decides, the roles, how a change gets in, contributor certification, sensitive access, and continuity. Code of conduct The Contributor Covenant 2.1 as adopted here: the bar for behaviour, where to report a breach, and the enforcement ladder. OpenSSF answer sheet Where the Scorecard number is capped here, and the Best Practices questionnaire answers.