Module paths 

Every control path this tool names, declared once.

Two kinds of path meet here and stay apart. A control path is this tool’s own: the instance directory, the declaration, the debt files, the hook configuration, the agent digest, the state and cache roots, and the agent skill roots. A destination is what a release projects into a target, and it is versioned data rather than a constant, so it stays with the projection and reaches this module only as a resolved value.

The module is otherwise pure. It reads no filesystem. It reads the process environment in exactly one place, UserEnv::from_process, so every resolver below takes the environment as an argument and a test constructs one instead of mutating the process.

Structs

ActivePaths

One landed instance’s paths, as the record and the environment leave them.

AgentRoot

One agent skill root, and what relocates it.

AgentRootEntry

One resolved agent skill root.

CandidatePaths

One profile’s destinations, derived and recorded nowhere.

InstancePaths

Every control and documentation destination inside one target.

PathEntry

One resolved path, and what decided it.

Paths

Every path this binary can name for one target and one user.

Proposals

The choices this target offers for the docs scratch.

UserEnv

What the process environment carries, read once and passed down.

UserPaths

Every user-scope path, resolved.

Enums

AgentId

Which agent family a skill root serves.

LocationChoice

One answer the operator can give for a location the project owns.

PathSource

What decided a path.

ProjectLocation

Where a location the project owns actually sits.

Constants

AGENTS_DIGEST_PATH

Where the documentation block lives in a target.

AGENTS_ROOT

The skill root every other agent reads, relative to the home directory.

AGENT_ROOTS

Every agent skill root this tool writes, in report order.

CACHE_ROOT

The cache root, relative to the home directory, where no variable moves it.

CI_VAR

The variable a continuous-integration environment sets, where the pin is whatever the checkout carries.

CLAUDE_CONFIG_DIR_VAR

The variable relocating Claude Code’s whole configuration directory.

CLAUDE_ROOT

The skill root Claude Code reads, relative to the home directory.

CONFIG_PATH

Where an instance keeps its declaration.

DEBT_PATH

Where an instance keeps its debt.

DOCS_SCRATCH_LEAVES

The directories a target already carries that a docs scratch could be.

DOCS_SCRATCH_VAR

The variable that names the docs scratch.

HOME_VAR

The variable naming the invoking user’s home directory.

HOOKS_CONFIG_PATH

Where a pre-commit configuration lives in a target.

INSTANCE_DIR

The instance directory, relative to the instance root.

LEGACY_DEBT_PATH

The flat list of exempt chapters an older instance carries.

LEGACY_SHARED_ROOT

The retired root that once held what every skill shares.

LEGACY_SKILL_RECEIPT_PATH

The user-scope skill receipt at the home-relative path, read once.

MANIFEST_PATH

The manifest path, relative to the instance root.

OFFLINE_VAR

The variable that tells this tool to reach no network.

PRUNABLE_ROOTS

The only roots an upgrade may remove dropped managed files from.

SELF_DEPEND_OFF_VAR

The variable an operator sets to hold the consumer pin where it is.

SELF_DEPEND_STAMP_DIR

The per-checkout sync stamps, relative to the state root.

SKILL_FILE

The one file every skill package must carry.

SKILL_LOCK_FILE

The user-scope lock, relative to the state root.

SKILL_RECEIPT_FILE

The user-scope skill receipt, relative to the state root.

SKILL_REFERENCES_DIR

Where a skill package holds what the shared source materialized into it.

STATE_ROOT

The state root, relative to the home directory, where no variable moves it.

TOOL_DIR

This tool’s directory name under a base directory.

XDG_CACHE_HOME_VAR

The variable naming the XDG cache base directory.

XDG_STATE_HOME_VAR

The variable naming the XDG state base directory.

Functions

agent_root

The agent root one identifier names.

candidates

One profile’s derived destinations, per profile, keyed by its name.

docs_scratch_location

Where the record says the docs scratch sits.

instance_paths

Every destination one documentation root implies.

proposals

What this target offers for the docs scratch.

recorded_paths

The same destinations, marked as the record’s rather than a profile’s.

variable

What one variable carries, or None where it is unset or blank.