S3 Browser CLI. Command Line Tools for Amazon S3. CLI Uploader, Downloader, Folder Sync Tool.
S3 Browser
Free Windows Client for Amazon S3 and Amazon CloudFront
 
Follow:
Share:

Command Line Interface


Command Line Interface Overview

S3 Browser provides a simple command-line interface for common tasks to help automate configuration changes and various file operations, including file uploads, downloads, deletions, listings, copying, moving, and syncing.

To Access the S3 Browser Command Line Interface:

1. Press Win+R to open the Run dialog:

run dialog

Windows Run Dialog

2. Type cmd and press Enter. The Windows Command Line dialog will open.

3. To start the CLI, run the following commands:

cd "%ProgramFiles%\S3 Browser"

s3browser-cli

The following output will be displayed:

Usage:

  s3browser-cli /<object> <command> [parameters]

Available objects:

  account
  file
  license
  data-integrity
  error-handling
  fs
  logging
  other
  permissions
  power
  proxy
  queueing
  throttling
  transfer
  ui

To get detailed help for each object, use

  s3browser-cli /<object>

Account

The account object provides you with the interface to manage storage accounts.

To get detailed help for the account object, run the following command:

s3browser-cli /account

The following output will be displayed:

Available commands:

  add
  update
  show
  delete
  update-credentials

To get detailed help for each command, use

  s3browser-cli /account <command>

add

The add command lets you add a new storage account

To get detailed help for the add command, run the following command:

s3browser-cli /account add

The following output will be displayed:

Please use the following syntax to add a new account:

s3browser-cli /account add <type> <name> <properties>

  <type>       - account type code, see below for supported values

  <name>       - any name you would like to assign to your account

  <properties> - account-type specific properties as comma-separated key=value pairs

                 type s3browser-cli /account add <type> for more details

  Supported account types:

     0: Amazon S3 Storage

     1: S3 Compatible Storage

     2: Amazon S3 in China

     3: Amazon S3 GovCloud Storage

    33: Amazon S3 GovCloud Storage (FIPS 140-2)

     4: Amazon S3 via EC2 IAM Role

    44: Amazon S3 via AssumeRole

    45: Amazon S3 via GetSessionToken

    46: Amazon S3 via SSO

     5: Amazon S3 (Credentials from Environment Variables)

     6: Amazon S3 (Credentials from AWS Config or Credential file)

Account-type-specific help messages provide you with more information about account-type-specific properties.

For example, the following command shows detailed help for parameters required for Amazon S3 Account:

s3browser-cli /account add 0

The following output will be displayed:

Please use the following syntax to add a new Amazon S3 Storage account:

s3browser-cli /account add 0 <name> <properties>

  <name>       - any name you would like to assign to your account

  <properties> - Amazon S3 Storage account properties as comma-separated key=value pairs

Mandatory properties:

  access-key-id      - Your Access Key Id

  secret-access-key  - Your Secret Access Key

Optional properties:

  password               - Master Password to encrypt your Access Key Id and Secret Access Key

  new-password           - New Master Password to encrypt your Access Key Id and Secret Access Key

  tls                    - true/false, if set to true, all communication with the storage will be encrypted using TLS

  dualstack-endpoints    - true/false, if set to true dualstack endpoints will be used when available

  list-all-my-buckets    - true/false, if set to true all buckets list retrieved from S3 when account assigned in GUI mode

  list-cf-distributions  - true/false, if set to true all CloudFront distributions retrieved when account assigned in GUI mode

  transfer-acceleration  - true/false, if set to true transfer acceleration will be used when uploading objects

  external-buckets       - Semicolon-separated list of external buckets, for example bucket-1;bucket-2/path;bucket-3

  recent-bucket          - The name of the most recently accessed bucket. This is used to preselect the bucket in the UI

For example, to add a new Amazon S3 Storage account, run the following command:

s3browser-cli /account add 0 "My Amazon S3 Account" access-key-id=YOUR_ACCESS_KEY_ID secret-access-key=YOUR_SECRET_ACCESS_KEY

To get detailed help for the add command for S3 Compatible Storage Account, run the following command:

s3browser-cli /account add 1

The following output will be displayed:

Please use the following syntax to add a new S3 Compatible Storage account:

s3browser-cli /account add 1 <name> <properties>

  <name>       - any name you would like to assign to your account

  <properties> - S3 Compatible Storage account properties as comma-separated key=value pairs

Mandatory properties:

  api-endpoint       - S3-compatible API endpoint, for example: s3.server.com or 172.30.2.111:1784

  access-key-id      - Your Access Key Id

  secret-access-key  - Your Secret Access Key

Optional properties:

  iam-endpoint              - IAM-compatible API endpoint, for example: iam.server.com or 10.10.2.111:8080

  password                  - Master Password to encrypt your Access Key Id and Secret Access Key

  new-password              - New Master Password to encrypt your Access Key Id and Secret Access Key

  tls                       - true/false, if set to true, all communication with the storage will be encrypted using TLS

  signature-version         - Supported values: 2 or 4. Version 4 is recommended when supported by the storage

  addressing-model          - Specify 0 for Path style and 1 for Virtual hosted style

  custom-regions            - Semicolon-separated list of custom region names and codes, for example US-East-1=us-east-1;US-West-1=us-west-1

  regional-endpoint         - Use {region-code} variable, for example s3.{region-code}.wasabisys.com

  list-all-my-buckets       - true/false, if set to true all buckets list retrieved from S3 when account assigned in GUI mode

  list-all-regions-buckets  - true/false, if set to true all buckets retrieved from all regions

  bulk-delete               - true/false, if set to true multi-object delete will be used when deleting objects

  multi-part-copy           - true/false, if set to true multi-part copy will be used when copying objects

  external-buckets          - Semicolon-separated list of external buckets, for example bucket-1;bucket-2/path;bucket-3

  recent-bucket          - The name of the most recently accessed bucket. This is used to preselect the bucket in the UI

For example, to add a new S3 Compatible Storage account, run the following command:

s3browser-cli /account add 1 "My S3 Compatible Storage Account" api-endpoint=s3.server.com,access-key-id=YOUR_ACCESS,secret-access-key=YOUR_SECRET_ACCESS_KEY

update

The update command lets you update account properties.

To get detailed help for the update command, run the following command:

s3browser-cli /account update

The following output will be displayed:

Please use the following syntax to update account properties:

s3browser-cli /account update <name-or-id> <properties>

  <name-or-id> - account name or id you want to update properties for

  <properties> - account-type specific properties as comma-separated key=value pairs

                 type s3browser-cli /account update <name-or-id> for more details

For example, to update My Amazon S3 Account to use TLS, run the following command:

s3browser-cli /account update "My Amazon S3 Account" tls=true

show

The show command lets you show account details.

To get detailed help for the show command, run the following command:

s3browser-cli /account show

The following output will be displayed:

Please use the following syntax to show account details:

s3browser-cli /account show <name-or-id>

  <name-or-id> - the name of the account you want to show details for,

                 wildcards are supported, you can also use account id.

For example, to show details for My Amazon S3 Account, run the following command:

s3browser-cli /account show "My Amazon S3 Account"

The following output will be displayed:

Type: Amazon S3 Storage
Name: My Amazon S3 Account
ID: 0313c917
AccessKeyId: ********************
SecretAccessKey: ********************
TLS: True
UseDualstackEndpoints: True
ListAllMyBuckets: True
ListCloudFrontDistributions: True
UseTransferAcceleration: False

delete

The delete command lets you delete an account.

To get detailed help for the delete command, run the following command:

s3browser-cli /account delete

The following output will be displayed:

Please use the following syntax to delete an account:

s3browser-cli /account delete <name-or-id>

  <name-or-id> - the name of the account you want to delete,

                 wildcards are supported, you can also use account id.

For example, to delete My Amazon S3 Account, run the following command:

s3browser-cli /account delete "My Amazon S3 Account"

update-credentials

The update-credentials command lets you update account credentials from AWS config or credentials file.

To get detailed help for the update-credentials command, run the following command:

s3browser-cli /account update-credentials

The following output will be displayed:

To update account credentials from AWS config or credenials file:

s3browser-cli /account update-credentials <name-or-id> <config-file> <profile-name>

  <name-or-id>   - the name or ID of the account to update credentials for

  <config-file>  - path to AWS config or credentials file

  <profile-name> - profile name in AWS config or credentials file

For example, to update My Amazon S3 Account credentials from the AWS config file, run the following command:

s3browser-cli /account update-credentials "My Amazon S3 Account" "C:\Users\user\.aws\credentials" default

File

The file object provides you with the interface to manage files and folders.

To get detailed help for the file object, run the following command:

s3browser-cli /file

The following output will be displayed:

Available commands:

  upload
  download
  delete
  list
  list-versions
  sync
  copy
  move

To get detailed help for each command, use

  s3browser-cli /file <command>

upload

The upload command lets you upload files and folders.

To get detailed help for the upload command, run the following command:

s3browser-cli /file upload

The following output will be displayed:

Please use the following syntax to upload files and folders:

s3browser-cli /file upload <account>[:password] <source> <bucket[/folder]>

  <account>  - account name you specified when adding an account using UI wizard

  [password] - optional password to decrypt account credentials (master password)

  <source>   - local file or directory to upload (wildcards supported)

  <bucket[/folder]> - destination bucket and optional path

Notes:

  If spaces appear in the argument, enclose it in quotation marks (")

To upload a folder c:\backups to the my-bucket/backups bucket, run:

s3browser-cli /file upload "My Account" c:\backups my-bucket/backups

To upload all .doc files from the c:\docs folder to the my-bucket/docs bucket, use:

s3browser-cli /file upload my-account c:\docs\*.doc my-bucket/docs

Here's an example of passing arguments with spaces (e.g., E:\My Videos):

s3browser-cli /file upload my-account "E:\My Videos" bucket/videos

If your account is password-protected, you can specify the password as follows:

s3browser-cli /file upload my-account:85sd4df F:\Project my-bucket

download

The download command lets you download files and folders.

To get detailed help for the download command, run the following command:

s3browser-cli /file download

The following output will be displayed:

Please use the following syntax to download files and folders:

s3browser-cli /file download <account>[:password] <bucket[/folder/file]> <destination>

  <account>  - account name you specified when adding an account using UI wizard

  [password] - optional password to decrypt account credentials (master password)

  <bucket[/folder/file]> - bucket name and optional path (wildcards supported)

  <destination> - local directory where to save files

Notes:

  If spaces appear in the argument, enclose it in quotation marks (")

To download an entire bucket to a local folder, run:

s3browser-cli /file download my-account my-bucket C:\downloads

To download a specific directory, use:

s3browser-cli /file download encrypted-acc:password my-bucket/docs/ C:\docs

To download files by mask (e.g., all .docx files), use:

s3browser-cli /file download "My Account" my-bucket/docs/*.docx C:\downloads

To download a single file, run:

s3browser-cli /file download my-account my-bucket/docs/readme.txt C:\downloads

delete

The delete command lets you delete files and folders.

To get detailed help for the delete command, run the following command:

s3browser-cli /file delete

The following output will be displayed:

Please use the following syntax to delete files or folders:

s3browser-cli /file delete <account>[:password] <bucket[/folder/file]>

  <account>  - account name you specified when adding an account using UI wizard

  [password] - optional password to decrypt account credentials (master password)

  <bucket[/folder/file]> - bucket name and optional path (wildcards supported)

Notes:

  If spaces appear in the argument, enclose it in quotation marks (")

To delete an entire bucket, use:

s3browser-cli /file delete my-account my-bucket

To delete a specific directory, use:

s3browser-cli /file delete encrypted-account:password my-bucket/temp/

To delete files by mask (e.g., all .bak files), use:

s3browser-cli /file delete "My Account" my-bucket/temp/*.bak

To delete a single file, run:

s3browser-cli /file delete my-account my-bucket/temp/file.ext

list

The list command lets you list bucket contents.

To get detailed help for the list command, run the following command:

s3browser-cli /file list

The following output will be displayed:

Please use the following syntax to list bucket contents:

s3browser-cli /file list <account>[:password] [bucket/p] [options]

  <account>  - account name you specified when adding an account using UI wizard

  [password] - optional password to decrypt account credentials (master password)

  [bucket/p] - optional bucket name and path (wildcards supported)

  [options]  - comma-separated list of optional parameters:

      s      - display file sizes
      sh     - display file sizes in human-readable format
      dt     - display last modified date and time
      sc     - display storage class
      fp     - display full path
      asc=X  - sort in ascending order by key(k), size(s), date(dt), storage-class(sc)
      desc=X - sort in descending order by key(k), size(s), date(dt), storage-class(sc)

Notes:

  If spaces appear in the argument, enclose it in quotation marks (")

To list all buckets, use:

s3browser-cli /file list my-account

To list all files in a bucket, use:

s3browser-cli /file list "My Account" my-bucket

To list all files in a subfolder with options, run:

s3browser-cli /file list my-account my-bucket/Docs sh,dt,sc

To list files with sorting options, use:

s3browser-cli /file list my-account my-bucket/Docs sh,dt,sc,asc=s

To list files for an encrypted account, run:

s3browser-cli /file list encrypted-account:85sd4df my-bucket/Docs

list-versions

The list-versions command lets you list file versions in a bucket.

To get detailed help for the list-versions command, run the following command:

s3browser-cli /file list-versions

The following output will be displayed:

Please use the following syntax to list versions:

s3browser-cli /file list-versions <account>[:password] <bucket>[/path] [filter]

  <account>  - account name you specified when adding an account using UI wizard

  [password] - optional password to decrypt account credentials (master password)

  <bucket>[/path] - bucket name and optional path (wildcards supported)

  [filter]   - one of the optional filters:

      deleted-files            - display only deleted files
      multi-version-files      - display only multi-version files
      current-versions         - display only current versions
      non-current-versions     - display only non-current versions
      files-with-versions-ge=n - display only files with versions number greater or equal to n
      files-with-versions-le=n - display only files with versions number less or equal to n

Notes:

  If spaces appear in the argument, enclose it in quotation marks (")

To list all versions in a bucket, use:

s3browser-cli /file list-versions my-account my-bucket

To list deleted files in a folder, run:

s3browser-cli /file list-versions my-account my-bucket/my-folder deleted-files

To list files with more than 3 versions, use:

s3browser-cli /file list-versions my-account my-bucket files-with-versions-ge=3

To list all versions for a specific file, run:

s3browser-cli /file list-versions my-account my-bucket/docs/readme.txt

To list versions for files with a specific extension, use:

s3browser-cli /file list-versions my-account my-bucket/docs/*.doc

sync

The sync command lets you synchronize files between local and remote folders.

To get detailed help for the sync command, run the following command:

s3browser-cli /file sync

The following output will be displayed:

Please use the following syntax to sync files:

s3browser-cli /file sync <account>[:password] <source> <destination> [options]

  <account>  - account name you specified when adding an account using UI wizard

  [password] - optional password to decrypt account credentials (master password)

  <source>   - synchronization source path (local or remote, wildcards supported)

  <destination> - synchronization destination path (local or remote)

  [options]  - additional sync options, see below:

         ncd - file-changes to include - (n)ew, (c)hanged, (d)eleted

         h   - use hashes to compare files (slower but reliable)

         s   - start synchronization without a confirmation prompt

Notes:

  Remote paths must start with s3: prefix

  If spaces appear in the argument, enclose it in quotation marks (")

To synchronize a local folder to a remote bucket, run:

s3browser-cli /file sync my-account d:\photos s3:my-bucket/photos ncdh

To synchronize a remote bucket to a local folder, use:

s3browser-cli /file sync my-account s3:my-bucket/projects c:\projects nchs

To synchronize folders with spaces in their paths, run:

s3browser-cli /file sync my-account "e:\my videos" "s3:my-bucket/my videos" nds

To synchronize a folder from a password-protected account, use:

s3browser-cli /file sync account:85sd4df s3:my-bucket/Docs F:\Docs nds

copy

The copy command lets you copy files and folders between buckets.

To get detailed help for the copy command, run the following command:

s3browser-cli /file copy

The following output will be displayed:

Please use the following syntax to copy files or folders:

s3browser-cli /file copy <account>[:password] <src-path> <dst-path>

  <account>  - account name you specified when adding an account using UI wizard

  [password] - optional password to decrypt account credentials (master password)

  <src-path> - source bucket and optional path (wildcards supported)

  <dst-path> - destination bucket and optional path

Notes:

  If spaces appear in the argument, enclose it in quotation marks (")

To copy an entire bucket to another bucket, use:

s3browser-cli /file copy my-account my-bucket-1 my-bucket-2

To copy a directory from one bucket to another, run:

s3browser-cli /file copy my-account src-bucket/test/ dst-bucket

To copy files by mask (e.g., all .bak files) from a password-protected account, use:

s3browser-cli /file copy account:4!znUQwr@$3 my-bucket/test/*.bak dst-bucket

To copy a single file, run:

s3browser-cli /file copy my-account my-bucket/test/file.txt dst-bucket/test

move

The move command lets you move files and folders between buckets.

To get detailed help for the move command, run the following command:

s3browser-cli /file move

The following output will be displayed:

Please use the following syntax to move files or folders:

s3browser-cli /file move <account>[:password] <src-path> <dst-path>

  <account>  - account name you specified when adding an account using UI wizard

  [password] - optional password to decrypt account credentials (master password)

  <src-path> - source bucket and optional path (wildcards supported)

  <dst-path> - destination bucket and optional path

Notes:

  If spaces appear in the argument, enclose it in quotation marks (")

To move an entire bucket to another bucket, use:

s3browser-cli /file move my-account my-bucket-1 my-bucket-2

To move a directory from one bucket to another, run:

s3browser-cli /file move my-account src-bucket/test/ dst-bucket

To copy files by mask (e.g., all .bak files) from a password-protected account, use:

s3browser-cli /file move account:4!znUQwr@$3 my-bucket/test/*.bak dst-bucket

To move a single file, run:

s3browser-cli /file move my-account my-bucket/test/file.txt dst-bucket/test

License

The license object provides you with the interface to manage licenses.

To get detailed help for the license object, run the following command:

s3browser-cli /license

The following output will be displayed:

Available commands:

  show
  get-hwid
  get-license-id
  activate
  deactivate

To get detailed help for each command, use

  s3browser-cli /license <command>

show

The show command displays the license details.

To get the status of the license, run the following command:

s3browser-cli /license show

The following output will be displayed for a free version:

S3 Browser 12.1.5 - Free Version (for non-commercial use only)

For a Pro version, the output will be similar to:

S3 Browser 12.1.5 - Pro

get-hwid

The get-hwid command displays the hardware ID.

To get the hardware ID, run the following command:

s3browser-cli /license get-hwid

The following output will be displayed:

96892479018d432d0e2ebb7358dd530f

get-license-id

The get-license-id command displays the license ID.

To get the license ID, run the following command:

s3browser-cli /license get-license-id

The following output will be displayed:

4028ebed437ab013881d346db3919d5d

activate

The activate command lets you activate the license.

To get detailed help for the activate command, run the following command:

s3browser-cli /license activate

The following output will be displayed:

 Please use the following syntax to activate the license:

s3browser-cli /license activate <license-key> [overwrite] [silent]

  <license-key> - S3 Browser license key

  [overwrite] - if specified and S3 Browser already activated, current license is overwritten

  [silent] - if specified no log messages are written to the console

To activate the license, run the following command:

s3browser-cli /license activate AAAA-BBBB-CCCC-DDDD-EEEE

The following output will be displayed:

Please wait, connecting activation server..

Your license has been successfully activated. Thank you!

deactivate

The deactivate command lets you deactivate the license.

To deactivate the license, run the following command:

s3browser-cli /license deactivate

The following output will be displayed:

Please wait, connecting activation server..

Your license has been successfully deactivated.

Data Integrity

The data-integrity object provides you with the interface to manage data integrity settings for file uploads and downloads.

To get detailed help for the data-integrity object, run the following command:

s3browser-cli /data-integrity

The following output will be displayed:

Available commands:

  check-for-uploads
  check-for-downloads
  mode
  get
  set

To get detailed help for each command, use:

  s3browser-cli /data-integrity <command>

check-for-uploads

The check-for-uploads command lets you enable or disable data integrity checks during file uploads.

To get detailed help for the check-for-uploads command, run the following command:

s3browser-cli /data-integrity check-for-uploads

The following output will be displayed:

To set whether to check data integrity during file upload:

s3browser-cli /data-integrity check-for-uploads set <on|off>

  <on|off> - set 'on' to enable data integrity check during file upload; 'off' to disable

To get whether to check data integrity during file upload:

s3browser-cli /data-integrity check-for-uploads get

To enable data integrity checks during file uploads, run the following command:

s3browser-cli /data-integrity check-for-uploads set on

To get the current setting, run the following command:

s3browser-cli /data-integrity check-for-uploads get

The following output will be displayed:

on

check-for-downloads

The check-for-downloads command lets you enable or disable data integrity checks during file downloads.

To get detailed help for the check-for-downloads command, run the following command:

s3browser-cli /data-integrity check-for-downloads

The following output will be displayed:

To set whether to check data integrity during file download:

s3browser-cli /data-integrity check-for-downloads set <on|off>

  <on|off> - set 'on' to enable data integrity check during file download; 'off' to disable

To get whether to check data integrity during file download:

s3browser-cli /data-integrity check-for-downloads get

To enable data integrity checks during file downloads, run the following command:

s3browser-cli /data-integrity check-for-downloads set on

To get the current setting, run the following command:

s3browser-cli /data-integrity check-for-downloads get

The following output will be displayed:

on

mode

The mode command lets you set the data integrity check mode for downloaded files.

To get detailed help for the mode command, run the following command:

s3browser-cli /data-integrity mode

The following output will be displayed:

To set data integrity check mode for downloaded files:

s3browser-cli /data-integrity mode set <mode>

  <mode> - data integrity check mode for downloaded files:

    flexible - treat files with missing or invalid hashes as valid

    strict   - treat files with missing or invalid hashes as corrupted

To get data integrity check mode for downloaded files:

s3browser-cli /data-integrity mode get

To set the data integrity check mode to flexible, run the following command:

s3browser-cli /data-integrity mode set flexible

To get the current mode, run the following command:

s3browser-cli /data-integrity mode get

The following output will be displayed:

Flexible

get

The get command lets you view all data integrity settings.

To get all data integrity settings, run the following command:

s3browser-cli /data-integrity get

The following output will be displayed:

check-for-uploads  : on
check-for-downloads: on
mode               : Flexible

set

The set command lets you modify data integrity settings in bulk.

To set multiple data integrity settings, use the following syntax:

s3browser-cli /data-integrity set <setting=value>,<setting=value>,...

For example, to enable data integrity checks for uploads and downloads, and set the mode to strict, run the following command:

s3browser-cli /data-integrity set check-for-uploads=on,check-for-downloads=on,mode=strict

Error Handling

The error-handling object provides you with the interface to manage error handling settings for failed tasks.

To get detailed help for the error-handling object, run the following command:

s3browser-cli /error-handling

The following output will be displayed:

Available commands:

  max-retry-attempts
  retry-delay
  get
  set

To get detailed help for each command, use:

  s3browser-cli /error-handling <command>

max-retry-attempts

The max-retry-attempts command lets you set the maximum number of retry attempts for failed tasks.

To get detailed help for the max-retry-attempts command, run the following command:

s3browser-cli /error-handling max-retry-attempts

The following output will be displayed:

To set the maximum number of retry attempts for failed tasks:

s3browser-cli /error-handling max-retry-attempts set <number>

  <number> - specify how many times the task should be retried after a failure

To get the maximum number of retry attempts for failed tasks:

s3browser-cli /error-handling max-retry-attempts get

To set the maximum retry attempts to 5, run the following command:

s3browser-cli /error-handling max-retry-attempts set 5

To get the current setting, run the following command:

s3browser-cli /error-handling max-retry-attempts get

The following output will be displayed:

5

retry-delay

The retry-delay command lets you set the delay in seconds between retry attempts for failed tasks.

To get detailed help for the retry-delay command, run the following command:

s3browser-cli /error-handling retry-delay

The following output will be displayed:

To set the delay in seconds between retry attempts for failed tasks:

s3browser-cli /error-handling retry-delay set <seconds>

  <seconds> - specify the wait time in seconds before retrying a failed task

To get the delay in seconds between retry attempts for failed tasks:

s3browser-cli /error-handling retry-delay get

To set the retry delay to 3 seconds, run the following command:

s3browser-cli /error-handling retry-delay set 3

To get the current setting, run the following command:

s3browser-cli /error-handling retry-delay get

The following output will be displayed:

3

get

The get command lets you view all error-handling settings.

To get all error-handling settings, run the following command:

s3browser-cli /error-handling get

The following output will be displayed:

max-retry-attempts: 5
retry-delay       : 3

set

The set command lets you modify error-handling settings in bulk.

To set multiple error-handling settings, use the following syntax:

s3browser-cli /error-handling set <setting=value>,<setting=value>,...

For example, to set the maximum retry attempts to 5 and the retry delay to 2 seconds, run the following command:

s3browser-cli /error-handling set max-retry-attempts=5,retry-delay=2

File System

The fs object provides you with the interface to manage file system settings such as temporary folder paths, free space checks, and parallel disk access.

To get detailed help for the fs object, run the following command:

s3browser-cli /fs

The following output will be displayed:

Available commands:

  temp-folder-path
  check-free-space
  allow-parallel-disk-access
  get
  set

To get detailed help for each command, use:

  s3browser-cli /fs <command>

temp-folder-path

The temp-folder-path command lets you set or get the folder used for storing temporary files.

To get detailed help for the temp-folder-path command, run the following command:

s3browser-cli /fs temp-folder-path

The following output will be displayed:

To set the folder to store temporary files:

s3browser-cli /fs temp-folder-path set <path>

  <path> - specify the full path to the folder for storing temporary files

To get the folder to store temporary files:

s3browser-cli /fs temp-folder-path get

To set the temporary folder path to C:\Temp, run the following command:

s3browser-cli /fs temp-folder-path set C:\Temp

To get the current temporary folder path, run the following command:

s3browser-cli /fs temp-folder-path get

The following output will be displayed:

C:\Users\moiseev\AppData\Local\Temp\S3 Browser

check-free-space

The check-free-space command lets you enable or disable free drive space checks before downloading a file.

To get detailed help for the check-free-space command, run the following command:

s3browser-cli /fs check-free-space

The following output will be displayed:

To set whether to check for free drive space before downloading a file:

s3browser-cli /fs check-free-space set <on|off>

  <on|off> - on to enable free space checks, and off to disable them

To get whether to check for free drive space before downloading a file:

s3browser-cli /fs check-free-space get

To enable free space checks, run the following command:

s3browser-cli /fs check-free-space set on

To get the current setting, run the following command:

s3browser-cli /fs check-free-space get

The following output will be displayed:

on

allow-parallel-disk-access

The allow-parallel-disk-access command lets you enable or disable parallel disk access for hashing and encryption.

To get detailed help for the allow-parallel-disk-access command, run the following command:

s3browser-cli /fs allow-parallel-disk-access

The following output will be displayed:

To set whether to allow parallel disk access for hashing and encryption:

s3browser-cli /fs allow-parallel-disk-access set <on|off>

  <on|off> - on to enable parallel disk access, and off to disable it

To get whether to allow parallel disk access for hashing and encryption:

s3browser-cli /fs allow-parallel-disk-access get

To enable parallel disk access, run the following command:

s3browser-cli /fs allow-parallel-disk-access set on

To get the current setting, run the following command:

s3browser-cli /fs allow-parallel-disk-access get

The following output will be displayed:

off

get

The get command lets you view all file system settings.

To get all file system settings, run the following command:

s3browser-cli /fs get

The following output will be displayed:

temp-folder-path          : C:\Users\moiseev\AppData\Local\Temp\S3 Browser
check-free-space          : on
allow-parallel-disk-access: off

set

The set command lets you modify file system settings in bulk.

To set multiple file system settings, use the following syntax:

s3browser-cli /fs set <setting=value>,<setting=value>,...

For example, to set the temporary folder path to C:\Temp, enable free space checks, and enable parallel disk access, run the following command:

s3browser-cli /fs set temp-folder-path=C:\Temp,check-free-space=on,allow-parallel-disk-access=on

Logging

The logging object provides you with the interface to manage logging settings.

To get detailed help for the logging object, run the following command:

s3browser-cli /logging

The following output will be displayed:

Available commands:

  verbosity
  save-to-file
  remove-old-logs
  max-log-age-days
  get
  set

To get detailed help for each command, use

  s3browser-cli /logging <command>

verbosity

The verbosity command lets you set the log verbosity level.

To get detailed help for the verbosity command, run the following command:

s3browser-cli /logging verbosity

The following output will be displayed:

To set the log verbosity level:

s3browser-cli /logging verbosity set <verbosity>

  <verbosity> - log verbosity level - verbose, brief, warningsanderrors

To get the log verbosity level:

s3browser-cli /logging verbosity get

To set the log verbosity level to verbose, run the following command:

s3browser-cli /logging verbosity set verbose

To get the log verbosity level, run the following command:

s3browser-cli /logging verbosity get

The following output will be displayed:

verbose

save-to-file

The save-to-file command lets you set the save log to file flag.

To get detailed help for the save-to-file command, run the following command:

s3browser-cli /logging save-to-file

The following output will be displayed:

To set the save log to file flag:

s3browser-cli /logging save-to-file set <on|off>

  <on|off> - on to save log to file and off otherwise

To get the save log to file flag:

s3browser-cli /logging save-to-file get

To set the save log to file flag to on, run the following command:

s3browser-cli /logging save-to-file set on

To get the save log to file flag, run the following command:

s3browser-cli /logging save-to-file get

The following output will be displayed:

on

remove-old-logs

The remove-old-logs command lets you set the remove old logs flag.

To get detailed help for the remove-old-logs command, run the following command:

s3browser-cli /logging remove-old-logs

The following output will be displayed:

To set the remove old logs flag:

s3browser-cli /logging remove-old-logs set <on|off>

  <on|off> - on to remove old logs and off otherwise

To get the remove old logs flag:

s3browser-cli /logging remove-old-logs get

To set the remove old logs flag to on, run the following command:

s3browser-cli /logging remove-old-logs set on

To get the remove old logs flag, run the following command:

s3browser-cli /logging remove-old-logs get

The following output will be displayed:

on

max-log-age-days

The max-log-age-days command lets you set the maximum log age in days.

To get detailed help for the max-log-age-days command, run the following command:

s3browser-cli /logging max-log-age-days

The following output will be displayed:

To set the maximum log age in days:

s3browser-cli /logging max-log-age-days set <days>

  <days> - the maximum log age in days

To get the maximum log age in days:

s3browser-cli /logging max-log-age-days get

To set the maximum log age in days to 30, run the following command:

s3browser-cli /logging max-log-age-days set 30

To get the maximum log age in days, run the following command:

s3browser-cli /logging max-log-age-days get

The following output will be displayed:

30

get

The get command lets you view all logging settings.

To get all logging settings, run the following command:

s3browser-cli /logging get

The following output will be displayed:

verbosity       : brief
save-to-file    : on
remove-old-logs : on
max-log-age-days: 30

set

The set command lets you modify logging settings in bulk.

To set multiple logging settings, use the following syntax:

s3browser-cli /logging set <setting=value>,<setting=value>,...

For example, to set verbosity to verbose and max-log-age-days to 15, run the following command:

s3browser-cli /logging set verbosity=verbose,max-log-age-days=15

Other Settings

The other object provides you with the interface to manage miscellaneous settings such as update checks and SSL validation.

To get detailed help for the other object, run the following command:

s3browser-cli /other

The following output will be displayed:

Available commands:

  new-version-check
  bypass-ssl-validation
  get
  set

To get detailed help for each command, use:

  s3browser-cli /other <command>

new-version-check

The new-version-check command lets you enable or disable automatic software update checks.

To get detailed help for the new-version-check command, run the following command:

s3browser-cli /other new-version-check

The following output will be displayed:

To set whether to automatically check for software updates:

s3browser-cli /other new-version-check set <on|off>

  <on|off> - set 'on' to enable daily update checks, or 'off' to disable them

To get whether to automatically check for software updates:

s3browser-cli /other new-version-check get

To enable automatic software update checks, run the following command:

s3browser-cli /other new-version-check set on

To get the current setting, run the following command:

s3browser-cli /other new-version-check get

The following output will be displayed:

on

bypass-ssl-validation

The bypass-ssl-validation command lets you enable or disable bypassing SSL/TLS validation.

To get detailed help for the bypass-ssl-validation command, run the following command:

s3browser-cli /other bypass-ssl-validation

The following output will be displayed:

To set whether to bypass SSL/TLS validation:

s3browser-cli /other bypass-ssl-validation set <on|off>

  <on|off> - on to disable certificate validation and trust all certificates, and off to enforce validation

To get whether to bypass SSL/TLS validation:

s3browser-cli /other bypass-ssl-validation get

To enable bypassing SSL/TLS validation, run the following command:

s3browser-cli /other bypass-ssl-validation set on

To get the current setting, run the following command:

s3browser-cli /other bypass-ssl-validation get

The following output will be displayed:

off

get

The get command lets you view all miscellaneous settings.

To get all miscellaneous settings, run the following command:

s3browser-cli /other get

The following output will be displayed:

new-version-check    : on
bypass-ssl-validation: off

set

The set command lets you modify miscellaneous settings in bulk.

To set multiple miscellaneous settings, use the following syntax:

s3browser-cli /other set <setting=value>,<setting=value>,...

For example, to enable automatic update checks and bypass SSL validation, run the following command:

s3browser-cli /other set new-version-check=on,bypass-ssl-validation=on

Permissions

The permissions object provides you with the interface to manage permissions-related settings such as inheritance and preservation.

To get detailed help for the permissions object, run the following command:

s3browser-cli /permissions

The following output will be displayed:

Available commands:

  inherit
  preserve
  get
  set

To get detailed help for each command, use:

  s3browser-cli /permissions <command>

inherit

The inherit command lets you enable or disable inheriting permissions from the parent bucket.

To get detailed help for the inherit command, run the following command:

s3browser-cli /permissions inherit

The following output will be displayed:

To set whether to inherit permissions from the parent bucket:

s3browser-cli /permissions inherit set <on|off>

  <on|off> - set 'on' to inherit permissions; 'off' to disable inheritance

To get whether to inherit permissions from the parent bucket:

s3browser-cli /permissions inherit get

To enable permissions inheritance, run the following command:

s3browser-cli /permissions inherit set on

To get the current setting, run the following command:

s3browser-cli /permissions inherit get

The following output will be displayed:

off

preserve

The preserve command lets you enable or disable preserving permissions when overwriting existing files.

To get detailed help for the preserve command, run the following command:

s3browser-cli /permissions preserve

The following output will be displayed:

To set whether to preserve permissions when overwriting existing files:

s3browser-cli /permissions preserve set <on|off>

  <on|off> - set 'on' to preserve permissions; 'off' to disable preservation

To get whether to preserve permissions when overwriting existing files:

s3browser-cli /permissions preserve get

To enable preserving permissions, run the following command:

s3browser-cli /permissions preserve set on

To get the current setting, run the following command:

s3browser-cli /permissions preserve get

The following output will be displayed:

off

get

The get command lets you view all permissions settings.

To get all permissions settings, run the following command:

s3browser-cli /permissions get

The following output will be displayed:

inherit : off
preserve: off

set

The set command lets you modify permissions settings in bulk.

To set multiple permissions settings, use the following syntax:

s3browser-cli /permissions set <setting=value>,<setting=value>,...

For example, to enable permissions inheritance and disable permissions preservation, run the following command:

s3browser-cli /permissions set inherit=on,preserve=off

Power

The power object provides you with the interface to manage power settings.

To get detailed help for the power object, run the following command:

s3browser-cli /power

The following output will be displayed:

Available commands:

  prevent-sleep
  prevent-display-off
  get
  set

To get detailed help for each command, use:

  s3browser-cli /power <command>

prevent-sleep

The prevent-sleep command lets you enable or disable preventing the computer from going to sleep while there are active tasks.

To get detailed help for the prevent-sleep command, run the following command:

s3browser-cli /power prevent-sleep

The following output will be displayed:

To set preventing the computer from going to sleep while there are active tasks:

s3browser-cli /power prevent-sleep set <on|off>

  <on|off> - on to prevent the computer from going to sleep and off otherwise

To get preventing the computer from going to sleep while there are active tasks:

s3browser-cli /power prevent-sleep get

To set preventing the computer from going to sleep to on, run the following command:

s3browser-cli /power prevent-sleep set on

To get the current setting, run the following command:

s3browser-cli /power prevent-sleep get

The following output will be displayed:

off

prevent-display-off

The prevent-display-off command lets you enable or disable preventing the display from turning off while there are active tasks.

To get detailed help for the prevent-display-off command, run the following command:

s3browser-cli /power prevent-display-off

The following output will be displayed:

To set preventing the display from turning off while there are active tasks:

s3browser-cli /power prevent-display-off set <on|off>

  <on|off> - on to prevent the display from turning off and off otherwise

To get preventing the display from turning off while there are active tasks:

s3browser-cli /power prevent-display-off get

To set preventing the display from turning off to on, run the following command:

s3browser-cli /power prevent-display-off set on

To get the current setting, run the following command:

s3browser-cli /power prevent-display-off get

The following output will be displayed:

off

get

The get command lets you view all power settings.

To get all power settings, run the following command:

s3browser-cli /power get

The following output will be displayed:

prevent-sleep      : off
prevent-display-off: off

set

The set command lets you modify power settings in bulk.

To set multiple power settings, use the following syntax:

s3browser-cli /power set <setting=value>,<setting=value>,...

For example, to set preventing sleep to on and preventing display-off to on, run the following command:

s3browser-cli /power set prevent-sleep=on,prevent-display-off=on

Proxy

The proxy object provides you with the interface to manage proxy settings, including mode, address, port, and authentication.

To get detailed help for the proxy object, run the following command:

s3browser-cli /proxy

The following output will be displayed:

Available commands:

  mode
  address
  port
  authentication
  username
  password
  domain
  get
  set

To get detailed help for each command, use:

  s3browser-cli /proxy <command>

mode

The mode command lets you set or get the proxy mode.

To get detailed help for the mode command, run the following command:

s3browser-cli /proxy mode

The following output will be displayed:

To set the proxy mode:

s3browser-cli /proxy mode set <mode>

  <mode> - the proxy mode: disabled, auto, manual

To get the proxy mode:

s3browser-cli /proxy mode get

To set the proxy mode to manual, run the following command:

s3browser-cli /proxy mode set manual

To get the current proxy mode, run the following command:

s3browser-cli /proxy mode get

The following output will be displayed:

Disabled

address

The address command lets you set or get the proxy address.

To get detailed help for the address command, run the following command:

s3browser-cli /proxy address

The following output will be displayed:

To set the proxy address:

s3browser-cli /proxy address set <address>

  <address> - the proxy address

To get the proxy address:

s3browser-cli /proxy address get

To set the proxy address to 192.168.0.1, run the following command:

s3browser-cli /proxy address set 192.168.0.1

To get the current proxy address, run the following command:

s3browser-cli /proxy address get

The following output will be displayed:

192.168.0.1

port

The port command lets you set or get the proxy port.

To get detailed help for the port command, run the following command:

s3browser-cli /proxy port

The following output will be displayed:

To set the proxy port:

s3browser-cli /proxy port set <port>

  <port> - the proxy port

To get the proxy port:

s3browser-cli /proxy port get

To set the proxy port to 8080, run the following command:

s3browser-cli /proxy port set 8080

To get the current proxy port, run the following command:

s3browser-cli /proxy port get

The following output will be displayed:

8080

authentication

The authentication command lets you enable or disable proxy authentication.

To get detailed help for the authentication command, run the following command:

s3browser-cli /proxy authentication

The following output will be displayed:

To set the proxy authentication:

s3browser-cli /proxy authentication set <on|off>

  <on|off> - on to enable proxy authentication and off otherwise

To get the proxy authentication:

s3browser-cli /proxy authentication get

To enable proxy authentication, run the following command:

s3browser-cli /proxy authentication set on

To get the current setting, run the following command:

s3browser-cli /proxy authentication get

The following output will be displayed:

off

username

The username command lets you set or get the proxy username for authentication.

To get detailed help for the username command, run the following command:

s3browser-cli /proxy username

The following output will be displayed:

To set the proxy username:

s3browser-cli /proxy username set <username>

  <username> - the proxy username

To get the proxy username:

s3browser-cli /proxy username get

To set the proxy username to admin, run the following command:

s3browser-cli /proxy username set admin

To get the current proxy username, run the following command:

s3browser-cli /proxy username get

The following output will be displayed:

admin

password

The password command lets you set or get the proxy password for authentication.

To get detailed help for the password command, run the following command:

s3browser-cli /proxy password

The following output will be displayed:

To set the proxy password:

s3browser-cli /proxy password set <password>

  <password> - the proxy password

To get the proxy password:

s3browser-cli /proxy password get

To set the proxy password to d@DRe@a@omakwoH7gZ, run the following command:

s3browser-cli /proxy password set d@DRe@a@omakwoH7gZ

To get the current proxy password, run the following command:

s3browser-cli /proxy password get

The following output will be displayed:

d@DRe@a@omakwoH7gZ

domain

The domain command lets you set or get the proxy domain.

To get detailed help for the domain command, run the following command:

s3browser-cli /proxy domain

The following output will be displayed:

To set the proxy domain:

s3browser-cli /proxy domain set <domain>

  <domain> - the proxy domain

To get the proxy domain:

s3browser-cli /proxy domain get

To set the proxy domain to example.com, run the following command:

s3browser-cli /proxy domain set example.com

To get the current proxy domain, run the following command:

s3browser-cli /proxy domain get

The following output will be displayed:

example.com

get

The get command lets you view all proxy settings.

To get all proxy settings, run the following command:

s3browser-cli /proxy get

The following output will be displayed:

mode          : Disabled
address       : 
port          : 8080
authentication: off
username      : 
password      : 
domain        : 

set

The set command lets you modify proxy settings in bulk.

To set multiple proxy settings, use the following syntax:

s3browser-cli /proxy set <setting=value>,<setting=value>,...

For example, to enable manual proxy mode with address 192.168.0.1, port 8080, and authentication, run the following command:

s3browser-cli /proxy set mode=manual,address=192.168.0.1,port=8080,authentication=on

Queueing

The queueing object provides you with the interface to manage task queue settings, such as the maximum number of concurrent uploads, downloads, and other tasks.

To get detailed help for the queueing object, run the following command:

s3browser-cli /queueing

The following output will be displayed:

Available commands:

  uploads
  downloads
  other
  get
  set

To get detailed help for each command, use:

  s3browser-cli /queueing <command>

uploads

The uploads command lets you set or get the maximum number of concurrent uploads.

To get detailed help for the uploads command, run the following command:

s3browser-cli /queueing uploads

The following output will be displayed:

To set the maximum number of concurrent uploads:

s3browser-cli /queueing uploads set <number>

  <number> - the maximum number of concurrent uploads

To get the maximum number of concurrent uploads:

s3browser-cli /queueing uploads get

To set the maximum number of concurrent uploads to 50, run the following command:

s3browser-cli /queueing uploads set 50

To get the current setting, run the following command:

s3browser-cli /queueing uploads get

The following output will be displayed:

50

downloads

The downloads command lets you set or get the maximum number of concurrent downloads.

To get detailed help for the downloads command, run the following command:

s3browser-cli /queueing downloads

The following output will be displayed:

To set the maximum number of concurrent downloads:

s3browser-cli /queueing downloads set <number>

  <number> - the maximum number of concurrent downloads

To get the maximum number of concurrent downloads:

s3browser-cli /queueing downloads get

To set the maximum number of concurrent downloads to 50, run the following command:

s3browser-cli /queueing downloads set 50

To get the current setting, run the following command:

s3browser-cli /queueing downloads get

The following output will be displayed:

50

other

The other command lets you set or get the maximum number of concurrent other tasks.

To get detailed help for the other command, run the following command:

s3browser-cli /queueing other

The following output will be displayed:

To set the maximum number of concurrent other tasks:

s3browser-cli /queueing other set <number>

  <number> - the maximum number of concurrent other tasks

To get the maximum number of concurrent other tasks:

s3browser-cli /queueing other get

To set the maximum number of concurrent other tasks to 50, run the following command:

s3browser-cli /queueing other set 50

To get the current setting, run the following command:

s3browser-cli /queueing other get

The following output will be displayed:

50

get

The get command lets you view all queueing settings.

To get all queueing settings, run the following command:

s3browser-cli /queueing get

The following output will be displayed:

uploads  : 50
downloads: 50
other    : 50

set

The set command lets you modify queueing settings in bulk.

To set multiple queueing settings, use the following syntax:

s3browser-cli /queueing set <setting=value>,<setting=value>,...

For example, to set the maximum number of concurrent uploads to 20, downloads to 15, and other tasks to 10, run the following command:

s3browser-cli /queueing set uploads=20,downloads=15,other=10

Throttling

The throttling object provides you with the interface to manage throttling settings for transfer rates.

To get detailed help for the throttling object, run the following command:

s3browser-cli /throttling

The following output will be displayed:

Available commands:

  enabled
  rate
  get
  set

To get detailed help for each command, use:

  s3browser-cli /throttling <command>

enabled

The enabled command lets you enable or disable throttling.

To get detailed help for the enabled command, run the following command:

s3browser-cli /throttling enabled

The following output will be displayed:

To set whether to enable throttling:

s3browser-cli /throttling enabled set <on|off>

  <on|off> - set 'on' to enable throttling; 'off' to disable throttling

To get whether to enable throttling:

s3browser-cli /throttling enabled get

To enable throttling, run the following command:

s3browser-cli /throttling enabled set on

To get the current throttling status, run the following command:

s3browser-cli /throttling enabled get

The following output will be displayed:

off

rate

The rate command lets you set or get the maximum transfer rate per thread in KB/s.

To get detailed help for the rate command, run the following command:

s3browser-cli /throttling rate

The following output will be displayed:

To set maximum transfer rate per thread (KB/s):

s3browser-cli /throttling rate set <rate>

  <rate> - maximum transfer rate per thread in KB/s

To get maximum transfer rate per thread (KB/s):

s3browser-cli /throttling rate get

To set the maximum transfer rate per thread to 128 KB/s, run the following command:

s3browser-cli /throttling rate set 128

To get the current maximum transfer rate per thread, run the following command:

s3browser-cli /throttling rate get

The following output will be displayed:

32

get

The get command lets you view all throttling settings.

To get all throttling settings, run the following command:

s3browser-cli /throttling get

The following output will be displayed:

enabled: off
rate   : 32

set

The set command lets you modify throttling settings in bulk.

To set multiple throttling settings, use the following syntax:

s3browser-cli /throttling set <setting=value>,<setting=value>,...

For example, to enable throttling and set the maximum transfer rate per thread to 64 KB/s, run the following command:

s3browser-cli /throttling set enabled=on,rate=64

Transfer

The transfer object provides you with the interface to manage file transfer settings.

To get detailed help for the transfer object, run the following command:

s3browser-cli /transfer

The following output will be displayed:

Available commands:

  multi-part-uploads
  multi-part-uploads-part-size
  multi-part-downloads
  multi-part-downloads-part-size
  overwrite-existing-files
  get
  set

To get detailed help for each command, use:

  s3browser-cli /transfer <command>

multi-part-uploads

The multi-part-uploads command lets you enable or disable multi-part uploads for large files.

To get detailed help for the multi-part-uploads command, run the following command:

s3browser-cli /transfer multi-part-uploads

The following output will be displayed:

To set whether to enable multi-part uploads for large files:

s3browser-cli /transfer multi-part-uploads set <on|off>

  <on|off> - set 'on' to enable multi-part uploads, or 'off' to disable them

To get whether to enable multi-part uploads for large files:

s3browser-cli /transfer multi-part-uploads get

To enable multi-part uploads, run the following command:

s3browser-cli /transfer multi-part-uploads set on

To get the current setting, run the following command:

s3browser-cli /transfer multi-part-uploads get

The following output will be displayed:

on

multi-part-uploads-part-size

The multi-part-uploads-part-size command lets you set the size of each part in a multi-part upload.

To get detailed help for the multi-part-uploads-part-size command, run the following command:

s3browser-cli /transfer multi-part-uploads-part-size

The following output will be displayed:

To set the size of each part in a multi-part upload:

s3browser-cli /transfer multi-part-uploads-part-size set <size>

  <size> - specifies the size of each part in megabytes

To get the size of each part in a multi-part upload:

s3browser-cli /transfer multi-part-uploads-part-size get

To set the part size to 8 MB, run the following command:

s3browser-cli /transfer multi-part-uploads-part-size set 8

To get the current part size, run the following command:

s3browser-cli /transfer multi-part-uploads-part-size get

The following output will be displayed:

8

multi-part-downloads

The multi-part-downloads command lets you enable or disable multi-part downloads for large files.

To get detailed help for the multi-part-downloads command, run the following command:

s3browser-cli /transfer multi-part-downloads

The following output will be displayed:

To set whether to enable multi-part downloads for large files:

s3browser-cli /transfer multi-part-downloads set <on|off>

  <on|off> - set 'on' to enable multi-part downloads, or 'off' to disable them

To get whether to enable multi-part downloads for large files:

s3browser-cli /transfer multi-part-downloads get

To enable multi-part downloads, run the following command:

s3browser-cli /transfer multi-part-downloads set on

To get the current setting, run the following command:

s3browser-cli /transfer multi-part-downloads get

The following output will be displayed:

on

multi-part-downloads-part-size

The multi-part-downloads-part-size command lets you set the size of each part in a multi-part download.

To get detailed help for the multi-part-downloads-part-size command, run the following command:

s3browser-cli /transfer multi-part-downloads-part-size

The following output will be displayed:

To set the size of each part in a multi-part download:

s3browser-cli /transfer multi-part-downloads-part-size set <size>

  <size> - specifies the size of each part in megabytes

To get the size of each part in a multi-part download:

s3browser-cli /transfer multi-part-downloads-part-size get

To set the part size to 8 MB, run the following command:

s3browser-cli /transfer multi-part-downloads-part-size set 8

To get the current part size, run the following command:

s3browser-cli /transfer multi-part-downloads-part-size get

The following output will be displayed:

8

overwrite-existing-files

The overwrite-existing-files command lets you specify the action to take when a file with the same name already exists.

To get detailed help for the overwrite-existing-files command, run the following command:

s3browser-cli /transfer overwrite-existing-files

The following output will be displayed:

To set the action to take when a file with the same name already exists:

s3browser-cli /transfer overwrite-existing-files set <action>

  <action> - specifies the action to take when a file with the same name already exists:

    ask       - show confirmation dialog

    overwrite - overwrite (replace the file in the destination)

    skip      - skip (do not overwrite, keep existing file)

    rename    - rename (keep both files, rename the new file automatically)

To get the action to take when a file with the same name already exists:

s3browser-cli /transfer overwrite-existing-files get

To set the action to take when a file with the same name already exists to overwrite, run the following command:

s3browser-cli /transfer overwrite-existing-files set overwrite

To get the current setting, run the following command:

s3browser-cli /transfer overwrite-existing-files get

The following output will be displayed:

overwrite

get

The get command lets you view all transfer settings.

To get all transfer settings, run the following command:

s3browser-cli /transfer get

The following output will be displayed:

multi-part-uploads            : on
multi-part-uploads-part-size  : 8
multi-part-downloads          : on
multi-part-downloads-part-size: 8
overwrite-existing-files      : overwrite

set

The set command lets you modify transfer settings in bulk.

To set multiple transfer settings, use the following syntax:

s3browser-cli /transfer set <setting=value>,<setting=value>,...

For example, to set multi-part uploads to on, multi-part uploads part size to 8 MB, multi-part downloads to on, multi-part downloads part size to 8 MB, and overwrite existing files to overwrite, run the following command:

s3browser-cli /transfer set multi-part-uploads=on,multi-part-uploads-part-size=8,multi-part-downloads=on,multi-part-downloads-part-size=8,overwrite-existing-files=overwrite

UI

The ui object provides you with the interface to manage user interface settings.

To get detailed help for the ui object, run the following command:

s3browser-cli /ui

The following output will be displayed:

Available commands:

  always-show-tray-icon
  minimize-to-system-tray
  bucket-pagination
  bucket-pagination-page-size
  limit-version-listings
  version-listing-limit
  limit-preview-file-size
  max-preview-file-size
  hide-access-keys
  hide-manage-accounts
  color-theme
  get
  set

To get detailed help for each command, use:

  s3browser-cli /ui <command>

always-show-tray-icon

The always-show-tray-icon command lets you set whether the S3 Browser icon is always shown in the system tray.

To get detailed help for the always-show-tray-icon command, run the following command:

s3browser-cli /ui always-show-tray-icon

The following output will be displayed:

To set whether the S3 Browser icon is always shown in the system tray:

s3browser-cli /ui always-show-tray-icon set <on|off>

  <on|off> - on to always show the icon, and off to hide it when not in use

To get whether the S3 Browser icon is always shown in the system tray:

s3browser-cli /ui always-show-tray-icon get

To enable the S3 Browser icon to always show in the system tray, run the following command:

s3browser-cli /ui always-show-tray-icon set on

To get the current setting, run the following command:

s3browser-cli /ui always-show-tray-icon get

The following output will be displayed:

on

minimize-to-system-tray

The minimize-to-system-tray command lets you set whether S3 Browser minimizes to the system tray.

To get detailed help for the minimize-to-system-tray command, run the following command:

s3browser-cli /ui minimize-to-system-tray

The following output will be displayed:

To set whether S3 Browser minimizes to the system tray:

s3browser-cli /ui minimize-to-system-tray set <on|off>

  <on|off> - on to minimize to the system tray, and off to minimize normally

To get whether S3 Browser minimizes to the system tray:

s3browser-cli /ui minimize-to-system-tray get

To enable S3 Browser to minimize to the system tray, run the following command:

s3browser-cli /ui minimize-to-system-tray set on

To get the current setting, run the following command:

s3browser-cli /ui minimize-to-system-tray get

The following output will be displayed:

on

bucket-pagination

The bucket-pagination command lets you enable or disable bucket pagination functionality.

To get detailed help for the bucket-pagination command, run the following command:

s3browser-cli /ui bucket-pagination

The following output will be displayed:

To set bucket pagination functionality:

s3browser-cli /ui bucket-pagination set <on|off>

  <on|off> - on to enable bucket pagination, and off to disable it

To get bucket pagination functionality:

s3browser-cli /ui bucket-pagination get

To enable bucket pagination functionality, run the following command:

s3browser-cli /ui bucket-pagination set on

To get the current setting, run the following command:

s3browser-cli /ui bucket-pagination get

The following output will be displayed:

on

bucket-pagination-page-size

The bucket-pagination-page-size command lets you set the page size for bucket pagination.

To get detailed help for the bucket-pagination-page-size command, run the following command:

s3browser-cli /ui bucket-pagination-page-size

The following output will be displayed:

To set the page size for bucket pagination:

s3browser-cli /ui bucket-pagination-page-size set <size>

  <size> - the number of items per page when listing buckets

To get the page size for bucket pagination:

s3browser-cli /ui bucket-pagination-page-size get

To set the page size for bucket pagination to 1000, run the following command:

s3browser-cli /ui bucket-pagination-page-size set 1000

To get the current page size for bucket pagination, run the following command:

s3browser-cli /ui bucket-pagination-page-size get

The following output will be displayed:

1000

limit-version-listings

The limit-version-listings command lets you enable or disable limiting items in version listings.

To get detailed help for the limit-version-listings command, run the following command:

s3browser-cli /ui limit-version-listings

The following output will be displayed:

To set limit items in version listings:

s3browser-cli /ui limit-version-listings set <on|off>

  <on|off> - on to enable version listing limits, and off to disable them

To get limit items in version listings:

s3browser-cli /ui limit-version-listings get

To enable limiting items in version listings, run the following command:

s3browser-cli /ui limit-version-listings set on

To get the current setting, run the following command:

s3browser-cli /ui limit-version-listings get

The following output will be displayed:

on

version-listing-limit

The version-listing-limit command lets you set the maximum number of items in version listings.

To get detailed help for the version-listing-limit command, run the following command:

s3browser-cli /ui version-listing-limit

The following output will be displayed:

To set the maximum number of items in version listings:

s3browser-cli /ui version-listing-limit set <limit>

  <limit> - the maximum number of items to display in version listings

To get the maximum number of items in version listings:

s3browser-cli /ui version-listing-limit get

To set the maximum number of items in version listings to 10000, run the following command:

s3browser-cli /ui version-listing-limit set 10000

To get the current maximum number of items in version listings, run the following command:

s3browser-cli /ui version-listing-limit get

The following output will be displayed:

10000

limit-preview-file-size

The limit-preview-file-size command lets you set the file size limit for preview.

To get detailed help for the limit-preview-file-size command, run the following command:

s3browser-cli /ui limit-preview-file-size

The following output will be displayed:

To set file size limit for preview:

s3browser-cli /ui limit-preview-file-size set <on|off>

  <on|off> - on to enable the file size limit, and off to disable it

To get file size limit for preview:

s3browser-cli /ui limit-preview-file-size get

To enable the file size limit for preview, run the following command:

s3browser-cli /ui limit-preview-file-size set on

To get the current setting, run the following command:

s3browser-cli /ui limit-preview-file-size get

The following output will be displayed:

on

max-preview-file-size

The max-preview-file-size command lets you set the maximum file size for preview in megabytes.

To get detailed help for the max-preview-file-size command, run the following command:

s3browser-cli /ui max-preview-file-size

The following output will be displayed:

To set the maximum file size for preview in megabytes:

s3browser-cli /ui max-preview-file-size set <size>

  <size> - the maximum file size (in MB) for downloading files for preview

To get the maximum file size for preview in megabytes:

s3browser-cli /ui max-preview-file-size get

To set the maximum file size for preview to 100 MB, run the following command:

s3browser-cli /ui max-preview-file-size set 100

To get the current maximum file size for preview, run the following command:

s3browser-cli /ui max-preview-file-size get

The following output will be displayed:

100

hide-access-keys

The hide-access-keys command lets you set access keys visibility in the UI.

To get detailed help for the hide-access-keys command, run the following command:

s3browser-cli /ui hide-access-keys

The following output will be displayed:

To set access keys visibility in the UI:

s3browser-cli /ui hide-access-keys set <on|off>

  <on|off> - on to disable access keys visibility, and off to enable it

To get access keys visibility in the UI:

s3browser-cli /ui hide-access-keys get

To disable access keys visibility in the UI, run the following command:

s3browser-cli /ui hide-access-keys set on

To get the current setting, run the following command:

s3browser-cli /ui hide-access-keys get

The following output will be displayed:

on

hide-manage-accounts

The hide-manage-accounts command lets you set accounts management visibility in the UI.

To get detailed help for the hide-manage-accounts command, run the following command:

s3browser-cli /ui hide-manage-accounts

The following output will be displayed:

To set accounts management visibility in the UI:

s3browser-cli /ui hide-manage-accounts set <on|off>

  <on|off> - on to hide accounts management, and off to show it

To get accounts management visibility in the UI:

s3browser-cli /ui hide-manage-accounts get

To hide accounts management in the UI, run the following command:

s3browser-cli /ui hide-manage-accounts set on

To get the current setting, run the following command:

s3browser-cli /ui hide-manage-accounts get

The following output will be displayed:

on

color-theme

The color-theme command lets you set the application color theme.

To get detailed help for the color-theme command, run the following command:

s3browser-cli /ui color-theme

The following output will be displayed:

To set the application color theme:

s3browser-cli /ui color-theme set <theme>

  <theme> - the color theme to use: light, dark, system

To get the application color theme:

s3browser-cli /ui color-theme get

To set the application color theme to Dark, run the following command:

s3browser-cli /ui color-theme set Dark

To get the current application color theme, run the following command:

s3browser-cli /ui color-theme get

The following output will be displayed:

Dark

get

The get command lets you view all UI settings.

To get all UI settings, run the following command:

s3browser-cli /ui get

The following output will be displayed:

always-show-tray-icon      : on
minimize-to-system-tray    : off
bucket-pagination          : off
bucket-pagination-page-size: 1000
limit-version-listings     : off
version-listing-limit      : 10000
limit-preview-file-size    : off
max-preview-file-size      : 100
hide-access-keys           : off
hide-manage-accounts       : off
color-theme                : Light

set

The set command lets you modify UI settings in bulk.

To set multiple UI settings, use the following syntax:

s3browser-cli /ui set <setting=value>,<setting=value>,...

For example, to set the S3 Browser icon to always show in the system tray and minimize to the system tray, run the following command:

s3browser-cli /ui set always-show-tray-icon=on,minimize-to-system-tray=on
S3 Browser 12.2.1 Freeware
Powered by Amazon Web Services and Rated by CNET Editors!
Social Connection
S3 Client Logo
 
People like S3 Browser!
Our customers say

"S3 Browser is an invaluable tool to me as a web developer to easily manage my automated site backups" -Bob Kraft, Web Developer

"Just want to show my appreciation for a wonderful product. I use S3 Browser a lot, it is a great tool." -Gideon Kuijten, Pro User

"Thank You Thank You Thank You for this tool. A must have for anyone using S3!" -Brian Cummiskey, USA

Related Products
RdpGuard
protects your Windows Server from RDP Brute-force Attacks.
"Amazon Web Services", "AWS", "Amazon S3", "Amazon Simple Storage Service", "Amazon CloudFront", "CloudFront", the "Powered by Amazon Web Services" logo are trademarks of Amazon.com, Inc. or its affiliates in the US and/or other countries.
Copyright © 2008-2025 Netsdk Software FZE. All rights reserved.  Terms of Use.  Privacy Policy.  S3 Drive.  RDP brute-force protection.