phux docs

phux documentation

Public documentation index. Start with the quickstart. Protocol, architecture, operations, and ADRs are separate reference sections.

stable document
Start here

You do not need the protocol to use phux. Pick the shortest path for what you are trying to do.

Start here

Your goalBest first page
Decide whether phux fits todayWhen to use phux
Run a persistent terminal and reattachQuickstart
Install through curl, Homebrew, a release, or sourceInstall
Let an agent inspect and drive that same terminalAgents
Reach your server from another machineRemote access
Change the prefix, keys, status bar, or hooksConfiguration
What phux isConcepts
Set up to contributeContributor setup

Task pages first; protocol, architecture, operations, and ADRs when you need to understand or extend the substrate.

The public site at https://phux.sh is generated from this tree. Documentation is served at https://docs.phux.sh (overview at /overview).

Working on the project

../CONTRIBUTING.md · CONVENTIONS.md · RELEASING.md

View exact source