[bldr]docs
CLI toolsbldr

bldr fs

Filesystem tree operations: import, materialise, and FUSE mount

bldr fs

Filesystem tree operations: import, materialise, and FUSE mount

bldr [BLDR FLAGS] fs <COMMAND>

bldr fs capture

Capture the current content of a mutable mount as an FsNode CID

bldr [BLDR FLAGS] fs capture [CAPTURE FLAGS] <ID> [PATH-IN-MOUNT]

<ID>

UUID of the mutable mount to capture (from fs mounts)

Required.

<PATH-IN-MOUNT>

Optional path within the mount to capture (default: the whole mount)

Defaults to ``.

-r, --ref <NAME>

Tag the captured CID under a named ref (repeatable)

May be given more than once.

bldr fs get

Materialise an FsNode tree from the node's store to a path on the server.

The CID must point to an FsNode root. If the blocks are not already stored locally and --local is not set, the node fetches them from the peer network before materialising.

PATH is an absolute path on the machine where builder-node is running.

bldr [BLDR FLAGS] fs get [GET FLAGS] <CID-OR-REF> <PATH>

<CID-OR-REF>

CID or named ref of the FsNode root

Required.

<PATH>

Absolute destination path on the server filesystem

Required.

-l, --local

Local store only; fail if any block is missing locally

Defaults to false.

bldr fs mount

Mount an FsNode DAG as a FUSE filesystem (read-only by default).

The server assigns a UUID to the mount printed on success. Use that UUID for fs update and fs unmount.

bldr [BLDR FLAGS] fs mount [MOUNT FLAGS] <CID-OR-REF> <PATH>

<CID-OR-REF>

CID or named ref to mount as the root FsNode

Required.

<PATH>

Absolute path of the empty directory to mount on

Required.

--fetch-timeout <SECS>

Block-fetch timeout in seconds (default: 30). FUSE operations return EIO if a remote block cannot be fetched within this time

Defaults to 30.

--mutable

Mount a writable content-addressed overlay: it starts at cid but is editable, and its content can be captured with fs capture

Defaults to false.

bldr fs mounts

List active FUSE mount points

bldr [BLDR FLAGS] fs mounts

bldr fs put

Walk a path on the server filesystem, store the tree as an FsNode DAG, and print the root CID.

PATH is an absolute path on the machine where builder-node is running.

bldr [BLDR FLAGS] fs put <PATH>

<PATH>

Absolute path on the server filesystem to import

Required.

bldr fs remount

Swap the root CID served by an existing mount without unmounting

bldr [BLDR FLAGS] fs remount <ID> <CID-OR-REF>

<ID>

UUID of the mount to update (from fs mounts)

Required.

<CID-OR-REF>

New CID or named ref to serve

Required.

bldr fs unmount

Unmount and remove a FUSE mount point

bldr [BLDR FLAGS] fs unmount <ID>

<ID>

UUID of the mount to remove (from fs mounts)

Required.

On this page