---
title: "All reference pages"
url: "https://docs.phux.sh/reference"
source: "https://github.com/no-phux/phux/blob/06139f37fe877c59ea6c10a70f8a79b4b21dc352/docs/reference/README.md"
projectVersion: "0.119.0"
protocolVersion: "1.0.0"
stability: "stable"
---

# All reference pages

Every page here is generated from the phux binary, so it matches the code the rest of the docs describe.

<!--
GENERATED FILE - do not edit. A unit test byte-compares this page
against `phux gen-reference-docs` output and fails on any drift, so
hand edits do not survive. Regenerate with `just docs-gen`.
-->

| Page | Contents |
|---|---|
| [Command line](/reference/cli) | Every non-hidden `phux` invocation path with its flags, defaults, and help text. |
| [Config settings](/reference/config) | Every `config.toml` section, the scalar defaults, and the annotated default config. |
| [Default key bindings](/reference/keys) | Every key phux binds out of the box, grouped as the which-key popup shows them. |
| [Actions](/reference/actions) | Every dispatcher action with its parameters, description, and palette placement. |
| [Status bar widgets](/reference/widgets) | Every registered status-bar widget kind with its options and defaults. |
| [Hook events](/reference/hooks) | Every hook event the server fires, with its context keys, environment projection, and matching rules. |
| [Exit codes](/reference/exit-codes) | Every exit code the binary uses and what each one means. |
| [Environment variables](/reference/environment) | Every environment variable the binary reads and what each one does. |
| [File locations](/reference/files) | The symbolic path rule for every file phux reads or writes: socket, config, logs, TLS material, tokens, bug reports, and the ideas spool. |
| [Deprecations](/reference/deprecations) | Every deprecated spelling, its replacement, and its removal release. |
| [Resource kinds](/reference/kinds) | Every resource kind, its methods and events, and the verb each frame and command needs. |
| [CLI and MCP parity](/reference/parity) | Every MCP tool, the CLI verb it mirrors, how it runs, and its annotations. |

Working on phux? Run `just docs-gen` after changing a command, setting, or anything else listed here; a unit test fails until the pages match the binary.