shares Command Reference

Shares Subcommands

The shares command offers the following subcommands:
upload upload files or directories to a Shares server
download download files or directories from a Shares server
browse browse a directory of a Shares server
delete delete a file, directory, or share
rename rename a file or directory

For examples of Shares subcommands in use, see Shares Examples

The upload Subcommand

Use the upload subcommand to upload content to a Shares server. The syntax for upload is as follows:
> aspera shares upload [args]

Arguments for the upload subcommand:

-i

---insecure

Accept the certificate, even if it's invalid.
-Hhost

--host=host

The Shares host name.
-spath

--source=path

File path to the source of the content you are uploading.
-dpath

--destination=path

Destination directory path (with the format /shareName/relativePathTo/fileOrFolder).
-ccookieString

--cookie=cookieString

Cookie, if one is required.
-p[password]

--password=[password]

The Shares user password.

If you specify -p but omit the password value, the Aspera CLI assumes an empty string for this value.

If you do not specify -p, the Aspera CLI prompts you for a non-echoing password.

Alternatively, you can set the ASPERA_PASS environment variable.

-uusername

--user=username

The Shares username.
-v

--verbose

Show more verbose output, for debugging.
-bpath

--base-ca-path=path

The base path for your CA certificates. If your certificates are in the default location, this argument is not required. The default path is ~/.aspera/cli/certs.

The download Subcommand

Use the download subcommand to download content from a Shares server. The syntax for download is as follows:
> aspera shares download [args]

Arguments for the download subcommand:

-i

---insecure

Accept the certificate, even if it's invalid.
-Hhost

--host=host

The Shares host name.
-spath

--source=path

File path to the source of the content you are downloading (with the format /shareName/relativePathTo/fileOrFolder).
-dpath

--destination=path

Destination directory path (the default is ./).
-ccookieString

--cookie=cookieString

Cookie, if one is required.
-p[password]

--password=[password]

The Shares user password.

If you specify -p but omit the password value, the Aspera CLI assumes an empty string for this value.

If you do not specify -p, the Aspera CLI prompts you for a non-echoing password.

Alternatively, you can set the ASPERA_PASS environment variable.

-uusername

--user=username

The Shares username.
-v

--verbose

Show more verbose output, for debugging.
-bpath

--base-ca-path=path

The base path for your CA certificates. If your certificates are in the default location, this argument is not required. The default path is ~/.aspera/cli/certs.

The browse Subcommand

Use the browse subcommand to see what content is on a Shares server. The syntax for browse is as follows:
> aspera shares browse [args]

Arguments for the browse subcommand:

-cnum

--count=num

List only up to num items.
-i

---insecure

Accept the certificate, even if it's invalid.
-j

--json

Output raw JSON.
-Hhost

--host=host

The Shares host name.
-Ppath

--path=path

The Shares remote path (the default is /; or use the format /shareName/relativePathTo/fileOrFolder).
-knum

--skip=num

Skip the first num items.
-oorder

--sort=order

Sort by order. The options for order are as follows:
  • type = sort directories first, then files
  • size_a = sort by file size (ascending)
  • size_d = sort by file size (descending)
  • mtime_a = sort by file modification time (ascending)
  • mtime_d = sort by file modification time (descending)
-p[password]

--password=[password]

The Shares user password.

If you specify -p but omit the password value, the Aspera CLI assumes an empty string for this value.

If you do not specify -p, the Aspera CLI prompts you for a non-echoing password.

Alternatively, you can set the ASPERA_PASS environment variable.

-uusername

--user=username

The Shares username.
-v

--verbose

Show more verbose output, for debugging.
-bpath

--base-ca-path=path

The base path for your CA certificates. If your certificates are in the default location, this argument is not required. The default path is ~/.aspera/cli/certs.

The delete Subcommand

Use the delete subcommand to delete content from a Shares server. The syntax for delete is as follows:
> aspera shares delete [args]

Arguments for the delete subcommand:

-i

---insecure

Accept the certificate, even if it's invalid.
-j

--json

Output raw JSON.
-Hhost

--host=host

The Shares host name.
-Ppath

--path=path

The path to the remote file or directory to be deleted (with the format /shareName/relativePathTo/fileOrFolder).
-p[password]

--password=[password]

The Shares user password.

If you specify -p but omit the password value, the Aspera CLI assumes an empty string for this value.

If you do not specify -p, the Aspera CLI prompts you for a non-echoing password.

Alternatively, you can set the ASPERA_PASS environment variable.

-uusername

--user=username

The Shares username.
-v

--verbose

Show more verbose output, for debugging.
-bpath

--base-ca-path=path

The base path for your CA certificates. If your certificates are in the default location, this argument is not required. The default path is ~/.aspera/cli/certs.

The rename Subcommand

Use the rename subcommand to rename content on a Shares server. The syntax for rename is as follows:
> aspera shares rename [args]

Arguments for the rename subcommand:

-i

---insecure

Accept the certificate, even if it's invalid.
-j

--json

Output raw JSON.
-Hhost

--host=host

The Shares host name.
-Ppath

--path=path

The remote path to the content you are renaming (with the format /shareName/relativePathTo/fileOrFolder).
-spath

--source=path

The remote file or directory you are renaming.
-dpath

--destination=path

The new name for the file or directory.
-p[password]

--password=[password]

The Shares user password.

If you specify -p but omit the password value, the Aspera CLI assumes an empty string for this value.

If you do not specify -p, the Aspera CLI prompts you for a non-echoing password.

Alternatively, you can set the ASPERA_PASS environment variable.

-uusername

--user=username

The Shares username.
-v

--verbose

Show more verbose output, for debugging.
-bpath

--base-ca-path=path

The base path for your CA certificates. If your certificates are in the default location, this argument is not required. The default path is ~/.aspera/cli/certs.