Command-line interface#

swh fs#

Software Heritage virtual file system

swh fs [OPTIONS] COMMAND [ARGS]...

Options

-C, --config-file <config_file>#: Configuration file (default: /home/jenkins/.config/swh/global.yml)

clean#

Clean on-disk cache(s).

swh fs clean [OPTIONS]

mount#

Mount the Software Heritage virtual file system at PATH.

If specified, objects referenced by the given SWHIDs will be prefetched and used to populate the virtual file system (VFS). Otherwise the VFS will be populated on-demand, when accessing its content.

Example:

$ mkdir swhfs
$ swh fs mount swhfs/
$ grep printf swhfs/archive/swh:1:cnt:c839dea9e8e6f0528b468214348fee8669b305b2
    printf("Hello, World!");
$

swh fs mount [OPTIONS] PATH [SWHID]...

Options

-f, --foreground, -d, --daemon#: whether to run FUSE attached to the console (foreground) or daemonized in the background (default: daemon)

Arguments

PATH#: Required argument

[SWHID]...#: Optional argument(s)

umount#

Unmount a mounted virtual file system.

Note: this is equivalent to fusermount -u PATH, which can be used to unmount any FUSE-based virtual file system. See man fusermount3.

swh fs umount [OPTIONS] PATH