paseo-beam
v0.5.0
Published
Beam a Paseo workspace's working tree into your one running dev environment. Click Beam, or ask an agent to beam its own workspace in and out; beam out restores your checkout.
Readme
Beam

A Paseo plugin that continuously mirrors a workspace's entire working tree onto your local main checkout on disk, so an already-running dev environment with live-reload shows the workspace's changes without you switching branches there.
There are two ways to use it:
- You click Beam on a workspace, and its changes show up in your running app.
- You ask an agent, and it beams its own workspace in and out for you.
For example, tell your first mate you want to test a feature. It has that work beamed onto main, so you can try it in your running app, and it lines up the next piece of work. See Agents.
Requires Paseo 0.9.2 or newer.
Similar to Conductor's Spotlight feature.
What it does
While a beam is active, Beam watches the workspace directory and, on every change, overwrites your main checkout to match the workspace's current working tree:
- Beam in — snapshots main's exact current state (branch,
HEAD, index, and full working tree including uncommitted, staged, and untracked files), then starts a file watcher on the workspace and runs an immediate sync. Each sync detaches main'sHEADat the workspace'sHEADand rewrites main's tracked working tree and index to a snapshot of the workspace's full working tree. Main's branch never moves, so anything that reads it during a beam (a new worktree based on it, a diff against it) still sees your real branch, not the workspace's commits. - Beam out — stops the watcher and restores main to exactly its pre-beam state — branch, working tree, index, and untracked files all come back as if nothing ever happened.
The mirror is the full working tree, including uncommitted and untracked files, not just
committed changes. .gitignore is respected, so ignored files (for example .env, node_modules)
are not copied from the workspace, and main's own ignored files survive each sync. This is
intentional: your running stack keeps its local environment.
Syncs are mtime-stable: only files that actually differ are rewritten, so the dev server's watcher only reacts to real changes.
Beam appears in three places:
- a Beam header button (a ⚡ icon) in each workspace's header, next to the GitHub / "Update from main" controls — the primary control. It is the normal color when off and turns yellow while this workspace is beaming, with a tooltip that reflects the current state, and one click to beam in or out;
- a Beam workspace panel — toggle, status, and a live activity log of each sync;
- an Open Beam command-center item.
While a beam is active the workspace is also marked in Paseo's workspace list: its title gains a
⚡ prefix, and beam-out restores the title it had before. The original title is stored in the beam
state alongside main's branch and HEAD, so a beam-out after a daemon restart still puts it back.
If you rename the workspace during a beam, beam-out keeps your new name. A title that you start with
"⚡ " yourself loses that prefix at the next beam-out, because Beam cannot tell it from its own mark.
Beam does not message your agents on its own. Agents can ask for the beam themselves: see
Agents. Claude agents also learn about a beam from the beam-awareness hook
in maxwell-01/myStuff (claudeConfig/plugins/beam-awareness),
which adds hidden context to each prompt: an agent in the beaming workspace is told its changes appear
in the main checkout, and an agent in the main checkout is warned its edits are discarded at beam-out.
The hook reads mainPath from ~/.paseo-beam-active.json and workspaceDir from
<mainPath>/.git/beam-state.json, so changing either file's path or those fields breaks it.
Agents
An agent can beam its own workspace in and out without you. Beam adds three tools to every Claude, Codex and OpenCode agent created after the plugin is installed or updated:
beam_status: shows whether a beam is active, which workspace and agent hold it, whether the agent's own workspace holds it, and which agents are waiting for it, in order.beam_in: beams the agent's own workspace onto the main checkout. If another workspace holds the beam, it waits up towaitSeconds(0 to 300), then beams in. If the beam is still held, it says so and the agent calls again. The default wait is the most allowed: 300 s.0checks once.beam_out: stops the beam and restores the main checkout. Only the workspace that holds the beam can do this.
Beam never installs packages. When beam_in brings dependency manifests or lockfiles that differ
from what the main checkout had before the beam (for example package.json, any lockfile,
requirements*.txt, pyproject.toml, Cargo.toml, go.mod, Gemfile, composer.json, at any
depth, outside node_modules and vendor), its reply lists those files and tells the agent the main checkout's
installed packages may be out of date. If a later sync changes them again, the next beam_status
or beam_in reply to any agent in the holding workspace lists them. beam_out lists the ones the restore put back to their
pre-beam versions. The reply names no package manager: the agent decides whether and how to install.
The tools find the calling agent through PASEO_AGENT_ID. Codex does not pass that variable to MCP
servers, so Beam gives each Codex agent's tool server a random BEAM_AGENT_TOKEN and records which agent
it belongs to in ${PASEO_HOME:-$HOME/.paseo}/plugin-data/beam/agent-tokens.json when Paseo opens the agent.
Agents created before the update, and agents on other providers, run the same tools as a command
instead. The command's shell has PASEO_AGENT_ID:
node "${PASEO_HOME:-$HOME/.paseo}/plugin-data/beam/tool-proxy.cjs" beam_in --wait 120
node "${PASEO_HOME:-$HOME/.paseo}/plugin-data/beam/tool-proxy.cjs" beam_status
node "${PASEO_HOME:-$HOME/.paseo}/plugin-data/beam/tool-proxy.cjs" beam_outAn agent that runs beam_in --wait N must give the shell command a timeout longer than N seconds.
A command that is killed stops waiting and never beams in.
The command prints the reply and exits 1 when the tool reports an error.
Waiting works like this:
- Several agents can wait at once. Beam gives no guarantee about who goes first.
- When the beam is held,
beam_innames the agent that beamed in and tells the caller to message that agent that it is waiting. Beam keeps a list of the agents that were refused, in the order they first asked. The holding agent sees that list inbeam_status, in itsbeam_inreplies, and in itsbeam_outreply, which asks it to tell the first waiting agent that the beam is free. An agent leaves the list when it beams in, when its wait is cancelled, or 30 minutes after it last asked. - A click on the Beam button in the app does not wait in line. It beams in at once, or fails if the beam is held.
- If an agent's tool call is cancelled or its process dies, the wait stops and that agent never beams in afterwards.
- A beam is held by a workspace, not by an agent. It is released on its own when the holder workspace is archived or its directory is deleted. An agent that crashes does not release it: the agent, or you, must beam out.
Install
paseo plugin install https://github.com/maxwell-01/maxs-paseo-plugins.git:beam
paseo plugin lsThen open a workspace and either click the Beam (⚡) button in the workspace header, or open the Beam panel (or run Open Beam from the command center), and beam in.
Reversible — your main checkout is safe
Beam is reversible. Beaming in is safe even when main has uncommitted, staged, or untracked
work: before the first sync, Beam captures main's complete state as a git object snapshot stored
under refs/beam/original (a real commit chain in the object store — not git stash, which is
left untouched). Beaming out checks main's branch out again and restores its working tree, index,
and untracked files to exactly that snapshot, so it is as if the beam never happened, and it deletes
the temporary ref. Beaming in on a dirty main is therefore fine.
Ignored files (for example .env, node_modules) are never captured, never mirrored, and never
touched during beam-in, sync, or beam-out.
Notes and limitations
- One beam at a time, machine-wide. Beam tracks the single active mirror through a home pointer
file (
~/.paseo-beam-active.json) plus a per-checkout state file (<mainPath>/.git/beam-state.json). Beaming a second workspace — even onto a different checkout — while one is already active is rejected; beam out first. An agent can wait for the beam instead (see Agents). - Ignored during watch: any path segment named
.git,node_modules, or.context, and any filename containing.tmp.. - Crash caveat. If Paseo or your machine stops while a beam is active, main stays mirrored until
you beam out (which performs the restore). The snapshot survives under
refs/beam/originaleven if the state file is lost, because that ref is a 3-commit chain: the snapshot commit's tree is main's full pre-beam working tree, its parent commit's tree is the pre-beam index, and its grandparent is the pre-beamHEAD. Restore by hand with, where<branch>is the branch main was on:
A beam started by Beam 0.4.0 or older moved the branch itself: for one of those, rungit -C <mainPath> read-tree --reset -u refs/beam/original^{tree} git -C <mainPath> symbolic-ref HEAD refs/heads/<branch> git -C <mainPath> read-tree refs/beam/original^^{tree} git -C <mainPath> update-ref -d refs/beam/originalgit -C <mainPath> reset --soft refs/beam/original^^in place of thesymbolic-refline. A plaingit -C <mainPath> reset --hard refs/beam/originalonly gets the working-tree contents right — it points the branch at the syntheticbeam: pre-beam snapshotcommit instead of your real pre-beamHEAD, and it collapses whatever was staged vs. unstaged into one committed state. Use the four commands above to reproduce the pre-beam state exactly.
Development
cd beam
npm install
npm run typecheck
npm test