⚙ CLI Usage

📦 Providers

Repertory supports multiple storage backends, each defined at mount time:

Short	Long	Description
—	—	Sia (default). Chosen automatically when no provider flag is given.
`-s3`	`--s3`	Amazon S3 or S3-compatible storage.
`-sia`	`--sia`	Sia renterd backend.
`-en`	`--encrypt`	Transparent encryption provider. Read-only passthrough to a local folder or disk, decrypting both filenames and file contents with XChaCha20-Poly1305.
`-rm`	`--remote_mount`	Remote mount provider. Connects to another Repertory instance's shared mount over the network.

Short	Long	Description
`-cv`	`--check_version`	Test backend/daemon version compatibility.
`-dc`	`--display_config`	Display the current configuration for the provider.
`-dd [directory]`	`--data_directory [directory]`	Specify the data directory location.
`-di`	`--drive_information`	Retrieve and display drive/mount information.
`-gc`	`--generate_config`	Generate a new configuration file.
`-get [name]`	`--get [name]`	Get a specific configuration value by name.
`-gdi [API path]`	`--get_directory_items [API path]`	Get directory list in JSON format.
`-gi [API path]`	`--get_item_info [API path]`	Get item information in JSON format.
`-gpf`	`--get_pinned_files`	List all pinned files.
`-h`	`--help`	Display help.
`-nc`	—	Force disable console output.
`-hidden`	`--hidden`	Windows only — hide console window.
`-of`	`--open_files`	Show currently open files.
`-pf [API path]`	`--pin_file [API path]`	Pin a file to keep it available locally.
`-ps [API path]`	`--pinned_status [API path]`	Show pinned status for a file.
`-pw [password]`	`--password [password]`	Specify API password.
`-set`	`--set`	Set a configuration value by name.
`-status`	`--status`	Check provider mount status.
`-test`	`--test`	Run self-tests.
`-unmount`	`--unmount`	Unmount the provider.
`-uf [API path]`	`--unpin_file [API path]`	Remove a pin from a file.
`-us [user]`	`--user [user]`	Specify API user name.
`-V`	`--version`	Display version information.

Short	Long	Description
`-na [name]`	`--name [name]`	Unique configuration name [Required].

Short	Long	Description	Notes
`-ui`	`--ui`	Launch the embedded GUI.	—
`-lo`	`--launch_only`	Launch only the GUI without mounting.	Requires `--ui`.
`-up [port]`	`--ui_port [port]`	Set the GUI port number.	Requires `--ui`.

repertory --name my_sia_mount /mnt/sia

repertory --s3 --name my_s3_bucket /mnt/s3

repertory --encrypt --name secure_data /mnt/secure

repertory --check_version

repertory --ui --launch_only