coss.comshipyard

Files and environment

Where Shipyard keeps its state on the laptop and on boxes, and the variables it sets and reads.

Shipyard keeps two kinds of files:

  • State, which Shipyard writes: identities, trust stores, sockets, logs. It lives in the state directory: ~/Library/Application Support/berth on a Mac, ~/.config/berth (or $XDG_CONFIG_HOME/berth) on Linux. BERTH_HOME moves it; it must be an absolute path.
  • Things you write, by hand or through the app: hooks, flows, templates, themes, plugins, kits. They live in ~/.berth/; BERTH_USER_DIR moves it.

On the laptop

State, in <state>/client/:

Yours, in ~/.berth/:

On a box

State, in <state>/box/:

Yours, in ~/.berth/: hooks.json, flows.json, env.json, guard.json, network.json, runs.json, plugins/ and plugins.json; see the config reference.

Sessions run in tmux on its own socket (tmux -L berth).

Environment

What a worktree gets

Everything run in a worktree (setup and archive scripts, terminals and agents, exec, repository hooks, flow steps, services):

What a helper gets

A plugin's helper runs with a small environment of its own, not berthd's: what berthd itself was told (a token, a 1Password session) is not passed on.

What a hook gets

See events and gates.

What Shipyard reads

The laptop agent explains what runs where; the config reference has the shape of every file you write.

Last updated