Files¶

Support for the core Tapis file management is provided by the files command set. New, and of note, is support for wildcard include and exclude filters when uploading and downloading, as well as a “sync” mode for downloads that only retrieves files from Tapis if they are different from their local copy.

General Commands¶

files list¶

List contents of a Files path

tapis files list
    [--sort-ascending | --sort-descending]
    [-l INT]
    [-o INT]
    [--all]
    [--reverse]
    [--sort-size | --sort-time]
    AGAVE_URI

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

-l INT, --limit INT¶: Limit to N records (default: 100)

-o INT, --offset INT¶: Skip first N records

--all¶: Include hidden files

--reverse¶: Reverse sort order.

--sort-size¶: Sort by size before sorting lexicographically.

--sort-time¶: Sort by time modified before sorting lexicographically.

AGAVE_URI¶: Files URI (agave://)

Replaces legacy CLI command “files-list”

files show¶

Show details of a Files path

tapis files show [--all] AGAVE_URI

--all¶: Include hidden files

AGAVE_URI¶: Files URI (agave://)

Replaces legacy CLI command “files-list”

files history¶

List history for a Files

tapis files history
    [--sort-ascending | --sort-descending]
    [-l INT]
    [-o INT]
    AGAVE_URI

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

-l INT, --limit INT¶: Limit to N records (default: 100)

-o INT, --offset INT¶: Skip first N records

AGAVE_URI¶: Files URI (agave://)

Replaces legacy CLI command “files-history”

files mkdir¶

Create a directory on a System

tapis files mkdir AGAVE_URI DIRECTORY

AGAVE_URI¶: Files URI (agave://)

DIRECTORY¶: Name of the new directory (relative to <agave_uri>)

Replaces legacy CLI command “files-mkdir”

files copy¶

Copy a Files path between locations within Tapis

tapis files copy AGAVE_URI DESTINATION

AGAVE_URI¶: Files URI (agave://)

DESTINATION¶: Destination path

Replaces legacy CLI command “files-copy”

files move¶

Move a Files path from one location to another on a System

tapis files move AGAVE_URI DESTINATION

AGAVE_URI¶: Files URI (agave://)

DESTINATION¶: Destination path

Replaces legacy CLI command “files-move”

files delete¶

Delete a file or directory from Tapis

tapis files delete [--all] [--progress] AGAVE_URI

--all¶: Include hidden files

--progress¶: Report progress to STDERR

AGAVE_URI¶: Files URI (agave://)

Replaces legacy CLI command “files-delete”

files upload¶

Upload from local host to Tapis

tapis files upload
    [--exclude GLOB]
    [--force | --sync]
    [--callback URI]
    [--progress]
    AGAVE_URI
    FILEPATH

--exclude GLOB¶: Unix-style fileglob (specify multiple times)

--force¶: Always overwrite existing files

--sync¶: Overwrite files only when timestamp or size differs

--callback URI¶: A URI to notify when each upload import is complete. Can be an email address or http/s URL. If a URL is given, a GET will be made.

--progress¶: Report progress to STDERR

AGAVE_URI¶: Files URI (agave://)

FILEPATH¶: Path (relative to working directory)

Replaces legacy CLI command “files-upload”

files download¶

Download from Tapis to the local host

tapis files download
    [--exclude GLOB]
    [-W DIRECTORY]
    [--force | --sync]
    [--progress]
    AGAVE_URI

--exclude GLOB¶: Unix-style fileglob (specify multiple times)

-W DIRECTORY¶: Download directory

--force¶: Always overwrite existing files

--sync¶: Overwrite files only when timestamp or size differs

--progress¶: Report progress to STDERR

AGAVE_URI¶: Files URI (agave://)

Replaces legacy CLI command “files-get”

Sharing Commands¶

Manage access by other users to Tapis files and folders that you control.

files pems drop¶

Drop all granted permissions from a Files path

tapis files pems drop
    [--sort-ascending | --sort-descending]
    [-l INT]
    [-o INT]
    AGAVE_URI

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

-l INT, --limit INT¶: Limit to N records (default: 100)

-o INT, --offset INT¶: Skip first N records

AGAVE_URI¶: Files URI (agave://)

Replaces legacy CLI command “files-pems-update”

files pems grant¶

Grant permissions on a Files path to a User

tapis files pems grant
    [--sort-ascending | --sort-descending]
    [-l INT]
    [-o INT]
    AGAVE_URI
    USERNAME
    PERMISSION

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

-l INT, --limit INT¶: Limit to N records (default: 100)

-o INT, --offset INT¶: Skip first N records

AGAVE_URI¶: Files URI (agave://)

USERNAME¶: Tapis username

PERMISSION¶: Permission string (ALL| READ| WRITE| READ_WRITE| EXECUTE| READ_EXECUTE| WRITE_EXECUTE| NONE)

Replaces legacy CLI command “files-pems-update”

files pems list¶

List permissions for an specific Files path

tapis files pems list
    [--sort-ascending | --sort-descending]
    [-l INT]
    [-o INT]
    [--all]
    AGAVE_URI

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

-l INT, --limit INT¶: Limit to N records (default: 100)

-o INT, --offset INT¶: Skip first N records

--all¶: Include hidden files

AGAVE_URI¶: Files URI (agave://)

Replaces legacy CLI command “files-pems-list”

files pems revoke¶

Revoke permissions on a Files path for a User

tapis files pems revoke
    [--sort-ascending | --sort-descending]
    [-l INT]
    [-o INT]
    AGAVE_URI
    USERNAME

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

-l INT, --limit INT¶: Limit to N records (default: 100)

-o INT, --offset INT¶: Skip first N records

AGAVE_URI¶: Files URI (agave://)

USERNAME¶: Tapis username

Replaces legacy CLI command “files-pems-update”

files pems show¶

Show permissions on a Files path for a User

tapis files pems show AGAVE_URI USERNAME

AGAVE_URI¶: Files URI (agave://)

USERNAME¶: Tapis username

Replaces legacy CLI command “files-pems-list”