phux reference
Generated reference documentation, rendered from the compiled binary and byte-pinned by a freshness test so it cannot drift from the code.
Full source summary
Generated reference documentation, rendered from the compiled binary and byte-pinned by a freshness test so it cannot drift from the code. The table below routes to each page; none of these files is edited by hand.
Exact commands, defaults, actions, widgets, hooks, exit codes, and paths. These pages fail CI if they drift from phux.
Every file in this directory is rendered from the compiled phux binary by just docs-gen; none of it is written by hand. A unit test re-renders each page and byte-compares it against this tree, so the reference cannot drift from the binary without failing the test suite.
| Page | Contents |
|---|---|
| cli.md | Every non-hidden phux invocation path with its flags, defaults, and help text. |
| config.md | Every config.toml section, the scalar defaults, and the annotated default config. |
| actions.md | Every dispatcher action with its parameters, description, and palette placement. |
| widgets.md | Every registered status-bar widget kind with its options and defaults. |
| hooks.md | Every hook event the server fires, with its context keys, environment projection, and matching rules. |
| exit-codes.md | Every exit code the binary uses and what each one means. |
| files.md | The symbolic path rule for every file phux reads or writes: socket, config, logs, TLS material, tokens. |
| deprecations.md | Every deprecated spelling, its replacement, and its removal release. |
Remote access over an overlay network
Run phux --remote user@host and you are done: it resolves an already-registered host, or pairs one first (from a pasted connect code, or over your existing...
phux CLI reference
The complete phux command surface: one section per invocation path, each carrying the exact long help of the binary that generated it.