Session Kit documentation Everything here is written for one of four moments: getting it installed, using
it day to day, understanding what it trusts, or fixing something. Find the
moment you are in.
Back to the project README .
Document
What it covers
Install Session Kit Every install route, the supported shpool paths, provider setup, project import, and activation.
Use Session Kit Opening the picker, starting sessions, and what each command does once you are running.
Projects A project is a directory: the shortcut you launch it by, the settings it launches with, and the sessions that belong to it.
Document
What it covers
Picker navigation The home screen, the cursor-driven picker, mouse behaviour, action panels, machine sessions, and closed-session restore.
Configure Session Kit Every setting, including account enrolment, colour, terminal titles, and where host configuration lives.
Claude Code and Codex integration The exact contract with each provider, and what stays under the provider's control.
Document
What it covers
Troubleshooting Read-only checks first, then the named problems and their remedies.
Update and roll back How releases are installed and selected, and how to go back to one already on the machine.
Uninstall What session-kit uninstall removes, and what it deliberately leaves alone.
Migrate an older installation A procedure, not a command, for moving a hand-managed shpool setup onto Session Kit.
Document
What it covers
Architecture How shpool terminals are joined to provider processes without treating display text as identity.
Security and local data No hosted service, no telemetry: what is read, what is written, and what stays owner-only.
Vendor formats this kit depends on The provider files the kit reads and writes, which both vendors call internal and free to change.
These are kept in the open because the project's claims should be checkable.
Document
What it covers
Voice The contract for every string the kit can show a person, so every surface speaks one way.
Release process The public release checklist: one reviewed commit carried unchanged through export, artifact, tag, and publication.
Inventory modularization contract How the inventory facade and its implementation modules are allowed to move.
Elsewhere in the repository
Document
What it covers
CHANGELOG Release history.
Contributing What is welcome, and what may be declined.
Security policy Supported versions, and how to report a vulnerability privately.
shpool patches The optional patches, their scope, and their checks.