Skip to content

forkpress storage

forkpress storage inspects, attaches, detaches, and compacts mount-backed ForkPress branch storage.

Use it when you need to understand the selected COW file view or release mount-backed storage before moving or deleting a site.

Usage

Terminal window
forkpress storage <command> [options]

Subcommands

SubcommandPurpose
statusShow whether this site’s mount-backed storage is attached and summarize storage state.
mountAttach this site’s mount-backed storage.
detachDetach mount-backed storage so the work directory can be moved or deleted.
compactCompact detached macOS APFS sparsebundle storage.

status

Terminal window
forkpress storage status [--work-dir <path>]
OptionDefaultDescription
--work-dir <path>.forkpressSite state directory to inspect.

status prints the initialized storage strategy, selected file view, branch count, branch roots, mount state, and leftover staging directories from interrupted branch operations.

mount

Terminal window
forkpress storage mount [--work-dir <path>]
OptionDefaultDescription
--work-dir <path>.forkpressSite state directory whose mount-backed storage should be attached.

For APFS sparsebundle and Linux XFS loop file views, mount attaches storage and prints the public branch root. For direct reflink and file-copy views, it reports that no detachable mount is used.

detach

Terminal window
forkpress storage detach [--work-dir <path>] [--keep-server] [--timeout <seconds>] [--force]
OptionDefaultDescription
--work-dir <path>.forkpressSite state directory whose mount-backed storage should be detached.
--keep-serverDisabledDo not stop this site’s ForkPress server before detaching. If a matching server is running, the command fails instead of stopping it.
--timeout <seconds>10Seconds to wait when stopping the matching site server.
--forceDisabledForce detach. Use only after normal detach reports that the mount is busy.

detach stops the matching ForkPress server unless --keep-server is passed. On Linux XFS loop storage, explicit detach fails if another running ForkPress server is still using the shared volume.

compact

Terminal window
forkpress storage compact [--work-dir <path>] [--keep-server] [--timeout <seconds>] [--force]
OptionDefaultDescription
--work-dir <path>.forkpressSite state directory whose sparsebundle should be compacted.
--keep-serverDisabledDo not stop this site’s ForkPress server before compacting. If a matching server is running, the command fails instead of stopping it.
--timeout <seconds>10Seconds to wait when stopping the matching site server.
--forceDisabledForce detach before compacting. Use only after normal detach reports that the mount is busy.

compact applies only to macOS APFS sparsebundle COW storage. It detaches the sparsebundle first, then compacts it. For other file views, ForkPress reports that there is no compactable sparsebundle.

Examples

Inspect storage:

Terminal window
forkpress storage status

Attach mount-backed storage:

Terminal window
forkpress storage mount

Detach storage before moving a project:

Terminal window
forkpress storage detach

Compact a macOS sparsebundle:

Terminal window
forkpress storage compact

forkpress stop stops a server and performs automatic storage cleanup for the affected site. forkpress doctor storage probes local storage capabilities before or after initialization.