cd [<path>]

Change the current working directory to the new directory

<path> <string>:
 target path.

clear-selected

Clear the list of files selected for restore.

deselect <path>

Deselect an entry for restore.

This will return an error if the entry was not found in the list of entries selected for restore.

<path> <string>:
 path to entry to remove from list.

exit

Exit the shell

find <pattern> [OPTIONS]

Find entries in the catalog matching the given match pattern.

<pattern> <string>:
 Match pattern for matching files in the catalog.

Optional parameters:

--select <boolean>   (default=false):
 Add matching filenames to list for restore.

help [{<command>}] [OPTIONS]

Get help about specified command (or sub-command).

<command> <array>:
 Command. This may be a list in order to spefify nested sub-commands.

Optional parameters:

--verbose <boolean>:
 Verbose help.

list-selected [OPTIONS]

List entries currently selected for restore.

Optional parameters:

--patterns <boolean>   (default=false):
 List match patterns instead of the matching files.

ls [<path>]

List the content of working directory or given path.

<path> <string>:
 target path.

pwd

List the current working directory.

restore <target> [OPTIONS]

Restore the sub-archive given by the current working directory to target.

By further providing a pattern, the restore can be limited to a narrower subset of this sub-archive. If pattern is not present or empty, the full archive is restored to target.

<target> <string>:
 target path for restore on local filesystem.

Optional parameters:

--pattern <string>:
 match pattern to limit files for restore.

restore-selected <target>

Restore the selected entries to the given target path.

Target must not exist on the clients filesystem.

<target> <string>:
 target path for restore on local filesystem.

select <path>

Select an entry for restore.

This will return an error if the entry is already present in the list or if an invalid path was provided.

<path> <string>:
 target path.

stat <path>

Read the metadata for a given directory entry.

This is expensive because the data has to be read from the pxar archive, which means reading over the network.

<path> <string>:
 target path.