Account
An Account object provides you the interface to manage storage accounts.
Available commands are add, update, show,
delete, update-credentials
The add command lets you add new storage account
To add new account please use the following syntax:
/account add name type [properties]
name - any name you would like to assign to your account
type - account type code as shown below:
0: Amazon S3
1: Amazon S3 Compatible Storage
2: Amazon S3 in China
3: Amazon S3 GovCloud
33: Amazon S3 GovCloud (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)
properties - account type-specific properties:
for Amazon S3, Amazon S3 in China, Amazon S3 GovCloud, Amazon S3 GovCloud (FIPS 140-2):
access-key-id secret-access-key
for Amazon S3 Compatible Storage:
rest-endpoint access-key-id secret-access-key signature-version addressing-model
for Amazon S3 via EC2 IAM Role, Amazon S3 (Credentials from Environment Variables):
there are no account type specific properties
for Amazon S3 via AssumeRole:
role-arn [external-id] source-account
for Amazon S3 (Credentials from AWS Config or Credential file):
credentials-file credentials-file-profile
for Amazon S3 via SSO:
sso-start-url sso-region sso-account-id sso-role-name
for Amazon S3 via GetSessionToken:
source-account
The command without [properties] returns account-specific properties description
Account-type specific help messages provide you 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 "test account" 0
To add new Amazon S3 account please use the following syntax:
/account add name 0 access-key-id secret-access-key
name - any name you would like to assign to your account
type - account type code (0 for Amazon S3)
access-key-id - Your Access Key Id, more details at https://s3browser.com/keys
secret-access-key - Your Secret Access Key, more details at https://s3browser.com/keys
s3browser-cli /account add "test account" 0 AKIASAMPLEACCESSKEY RRll9kp9UgIi7HjKkLkOKmN9<..>
For Amazon S3-Compatible storage account:
s3browser-cli /account add "test account" 1
To add new Amazon S3 Compatible Storage account please use the following syntax:
/account add name 1 rest-endpoint access-key-id secret-access-key signature-version addressing-model
name - any name you would like to assign to your account
type - account type code (1 for Amazon S3 Compatible Storage)
rest-endpoint - S3-compatible API endpoint, for example: api.server.com or https://172.30.2.111:1784
access-key-id - Your Access Key Id, more details at https://s3browser.com/keys
secret-access-key - Your Secret Access Key, more details at https://s3browser.com/keys
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
s3browser-cli /account add wasabi 1 s3.wasabisys.com AKIASAMPLEACCESSKEY tVj5PY10zpklCN8YBRDjauuhNKqpY8MTr 4 1
The update command lets you update account properties
To update account properties please use the following syntax:
/account update name-or-id property-name property-value
name-or-id - the name of the account you want to update,
you may also use account id
property-name - the name of the property you want to update
property-value - the new value for the property
Suppported properties are:
name: Any name you would like to assign to your account
access-key-id: Your Access Key Id, more details at https://s3browser.com/keys
secret-access-key: Your Secret Access Key, more details at https://s3browser.com/keys
rest-endpoint: S3-compatible API endpoint, for example: api.server.com or https://1.2.3.4:444
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
enable-ssl: If set to true all communications with the storage will go through encrypted TLS channel
list-all-my-buckets: If set to true, in GUI mode buckets list retrieved from S3 when account assigned
list-cloudfront-distributions: If set to true, in GUI mode all CloudFront distributions retrieved when account assigned
external-buckets: Comma-separated list of external buckets, for example bucket-1, bucket-2/path, bucket-3
role-arn: The ARN of the role you want to assume (arn:aws:iam::<account-id>:role/<role-name>)
external-id: A unique identifier that might be required when you assume a role in another account
mfa-serial: The identification number of the MFA device to use when assuming a role
session-duration: The duration, in seconds, that temporary credentials should remain valid
source-account: The name or ID of the account to get credentials from for the initial STS call
credentials-file: Path to AWS config or credential file
credentials-file-profile: Name of the profile from AWS config or credential file
sso-start-url: Also known as User portal URL, for example https://<unique-id>.awsapps.com/start
sso-region: Please specify an SSO region for SSO API requests
sso-account-id: The identifier for the AWS account that is assigned to the user
sso-role-name: The friendly name of the role that is assigned to the user
Example:
s3browser-cli /account update local-st rest-endpoint https://172.30.2.111:1784
or
s3browser-cli /account update test-acc access-key-id AKIAT5ZWU75WMOVK3C5W
The show command displays account properties.
To show account details please use the following syntax:
/account show name-or-id
name-or-id - the name of the account you want to show details for
(wildcards supported), you may also use account id
Example:
s3browser-cli /account show wasabi-test
Output:
Amazon S3 Compatible Storage
----------------------------------------
Name: wasabi-test
Id: 24e2e05d
REST Endpoint: s3.wasabisys.com
Region-specific Endpoint:
Signature Version: Signature V4
Addressing Model: Virtual hosted style
AccessKeyId: **********************
SecretAccessKey: **************************************
SSL/TLS: True
The delete command lets you delete one or multiple accounts
To delete account please use the following syntax:
/account delete name-or-id
name-or-id - the name of the account you want to delete
(wildcards supported), you may also use account id
Example:
s3browser-cli /account delete wasabi-test
The update-credentials command updates account credentials
from AWS config or credentials file, this could be useful when temporary credentials are not
supported by your current account type, for example GovCloud account.
By running this command you can copy access keys and session token from the AWS config or
credentials file to the account you added earlier.
To update account credentials from AWS config or credenials file:
/account update-credentials name-or-id config-file profile-name
name-or-id - the name of the account you want to update
credentials for, you may also use account id
config-file - path to AWS config or credentials file
profile-name - profile name in AWS config or credentials file
Example:
s3browser-cli /account update-credentials test %USERPROFILE%\.aws\config default
File
The File object provides you the interface to work with files stored on Amazon S3.
Available commands are
upload,
download,
delete,
list,
sync,
copy,
move.
The upload command lets you upload files and folders to Amazon S3.
Please use the following syntax to upload files and folders:
---------------------------------------------------------------------------
/file upload account[:password] local-path bucket/folder
---------------------------------------------------------------------------
Where:
account - account name you specified when adding an account using gui wizard
password - optional password to decrypt account credentials (master password)
local-path - path to the file or directory on your disk (wildcards supported)
bucket/folder - amazon s3 bucket name and folder
Examples:
s3browser-cli /file upload my-account c:\backup my-bucket/backups
s3browser-cli /file upload my-account c:\backup\*.bkf my-bucket
s3browser-cli /file upload my-account "e:\my videos" "bucket-3/my videos"
s3browser-cli /file upload "encrypted account:85sd4df" F:\Docs bucket-4/Docs
If white-space appears in any argument, please enclose it in quotation marks as shown in examples above.
Please do not use traling backslash(!)
The download command lets you download files and folders from Amazon S3.
Please use the following syntax to download files and folders:
---------------------------------------------------------------------------
/file download account[:password] bucket/path local-path
---------------------------------------------------------------------------
Where:
account - account name you specified when adding an account using gui wizard
password - optional password to decrypt account credentials (master password)
bucket/path - amazon s3 bucket name and path (limited support for wildcards)
local-path - directory on your local disk
Examples:
s3browser-cli /file download my-account my-bucket/backups/ c:\downloads
s3browser-cli /file download my-account my-bucket/backups/file.bak c:\downloads
s3browser-cli /file download account "my-bucket/my backups/*" "c:\my downloads"
s3browser-cli /file download "encrypted account:85sd4df" bucket/Docs "F:\My Docs"
If white-space appears in any argument, please enclose it in quotation marks as shown in examples above.
Please do not use traling backslash(!)
The delete command lets you delete files, folders or entire buckets
Please use the following syntax to delete files, folders or buckets:
---------------------------------------------------------------------------
/file delete account[:password] bucket[/folder/file]
---------------------------------------------------------------------------
Where:
account - account name you specified when adding an account using gui wizard
password - optional password to decrypt account credentials (master password)
bucket[/folder/file] - bucket and optional path (limited support for wildcards)
Examples:
Delete entire bucket:
s3browser-cli /file delete my-account my-bucket
Delete entire directory:
s3browser-cli /file delete "encrypted account:password" my-bucket/temp/
Delete files by mask:
s3browser-cli /file delete my-account "my-bucket/test dir/*.bak"
Delete single file:
s3browser-cli /file delete my-account my-bucket/temp/note.txt
If white-space appears in any argument, please enclose it in quotation marks as shown in examples above.
Please do not use traling backslash(!)
The list command displays a list of files and folders in a bucket
Please use the following syntax to list bucket:
---------------------------------------------------------------------------
/file list account[:password] [bucket/path]
---------------------------------------------------------------------------
Where:
account - account name you specified when adding an account using gui wizard
password - optional password to decrypt account credentials (master password)
bucket/path - amazon s3 bucket name and path, leave it empty to list all buckets
Examples:
s3browser-cli /file list account-name
s3browser-cli /file list account-name my-bucket
s3browser-cli /file list encrypted-account:85sd4df "my-bucket/My Docs"
If white-space appears in any argument, please enclose it in quotation marks as shown in examples above.
Please do not use traling backslash(!)
The sync command lets you perform one-way synchronization between your
local folder and folder on Amazon S3 or vice versa.
Please use the following syntax for 1-way sync between local and remote folders
----------------------------------------------------------------------------
/file sync account[:password] source destination [options]
----------------------------------------------------------------------------
Where:
account - account name you specified when adding account using gui wizard
password - optional password to decrypt account credentials (master password)
source, destination - local-folder and remote-path or vise versa
local-folder - path to the directory located on your disk
remote-path - bucket name and optional folder starting with s3: prefix
[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
Examples:
s3browser-cli /file sync my-account d:\photos s3:my-bucket/photos ncdh
s3browser-cli /file sync my-account s3:my-bucket/projects c:\projects nchs
s3browser-cli /file sync my-account "e:\my videos" "s3:my-bucket/my videos" nds
s3browser-cli /file sync encrypted-account:85sd4df s3:my-bucket/Docs F:\Docs nds
If white-space appears in any argument, please enclose it in quotation marks as shown in examples above.
Please do not use traling backslash(!)
The copy command lets you copy files or folders
Please use the following syntax to copy files or folders
---------------------------------------------------------------------------
/file copy account[:password] src-path dst-path
---------------------------------------------------------------------------
Where:
account - account name you specified when adding an account using gui wizard
password - optional password to decrypt account credentials (master password)
src-path - source bucket and optional path (limited support for wildcards)
dst-path - destination bucket and optional path (limited support for wildcards)
Examples:
copy entire bucket:
s3browser-cli /file copy my-account my-bucket-1 my-bucket-2
copy entire bucket:
3browser-cli /file copy my-account my-bucket-1 my-bucket-2/subfolder/
copy directory:
s3browser-cli /file copy my-account src-bucket/test/ dst-bucket
copy directory:
s3browser-cli /file copy my-account src-bucket/test/ dst-bucket/subfolder/
copy files by mask:
s3browser-cli /file copy my-account my-bucket/test/*.bak dst-bucket
copy single file:
s3browser-cli /file copy my-account my-bucket/test/file.txt src-bucket/test/
If white-space appears in any argument, please enclose it in quotation marks as shown in examples above.
Please do not use traling backslash(!)
The move command lets you move files or folders
Please use the following syntax to move files or folders
---------------------------------------------------------------------------
/file move account[:password] src-path dst-path
---------------------------------------------------------------------------
Where:
account - account name you specified when adding an account using gui wizard
password - optional password to decrypt account credentials (master password)
src-path - source bucket and optional path (limited support for wildcards)
dst-path - destination bucket and optional path (limited support for wildcards)
Examples:
move entire bucket:
s3browser-cli /file move my-account my-bucket-1 my-bucket-2
move entire bucket:
3browser-cli /file move my-account my-bucket-1 my-bucket-2/subfolder/
move directory:
s3browser-cli /file move my-account src-bucket/test/ dst-bucket
move directory:
s3browser-cli /file move my-account src-bucket/test/ dst-bucket/subfolder/
move files by mask:
s3browser-cli /file move my-account my-bucket/test/*.bak dst-bucket
move single file:
s3browser-cli /file move my-account my-bucket/test/file.txt src-bucket/test/
If white-space appears in any argument, please enclose it in quotation marks as shown in examples above.
Please do not use traling backslash(!)
License
The License object provides you the interface to the licensing commands.
Available commands are
show,
get-hwid,
get-license-id,
activate,
deactivate.
The show command displays current license status
To get current license status please use the following syntax:
/license show
Example:
s3browser-cli /license show
Output:
S3 Browser 10.6.6 - Pro
The get-hwid command displays machine hardware ID
To get machine hardware ID please use the following syntax:
/license get-hwid
Example:
s3browser-cli /license get-hwid
Output:
5bc633bcaea9109e1b3b78fa4bf9257c
The get-license-id command displays license ID
To get license ID please use the following syntax:
/license get-license-id
Example:
s3browser-cli /license get-license-id
Output:
5bc633bcaea9109e1b3b78fa4bf9257c
The activate command lets you activate S3 Browser license.
To activate the license please use the following syntax:
/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
Examples:
s3browser-cli /license activate YOUR-S3BROWSER-LICENSE-KEY
s3browser-cli /license activate YOUR-S3BROWSER-LICENSE-KEY overwrite
s3browser-cli /license activate YOUR-S3BROWSER-LICENSE-KEY silent
s3browser-cli /license activate YOUR-S3BROWSER-LICENSE-KEY overwrite silent
Output:
Please wait, connecting activation server..
Your license has been successfully activated. Thank you!
The deactivate command lets you deactivate S3 Browser license.
To deactivate the license please use the following syntax:
/license deactivate [silent]
silent - if specified no log messages are written to the console
Examples:
s3browser-cli /license deactivate
s3browser-cli /license deactivate silent
Output:
Please wait, connecting activation server..
Your license has been successfully deactivated.
Logging
The Logging object lets you view/edit logging settings.
Available commands are
get,
set.
The get command displays current logging settings.
To get current logging settings please use the following syntax:
/logging get
Example:
s3browser-cli /logging get
Output:
Brief
The set command lets you set new logging settings.
To set logging level please use the following syntax:
/logging set logging-level
logging-level - supported levels are: Verbose, Brief, WarningsAndErrors
Example:
s3browser-cli logging set Verbose
Proxy
The Proxy object lets you view/edit proxy settings.
Available commands are
get,
set.
The get command displays current proxy settings.
To get current proxy settings please use the following syntax:
/proxy get
Example:
s3browser-cli /proxy get
Output:
DoNotUseProxy
The set command lets you set new proxy settings.
To set proxy settings please use the following syntax:
/proxy set proxy-type [host port [username] [password] [domain]]
proxy-type - supported types are: DoNotUseProxy, AutoDetect, UserDefined
for UserDefined proxy type the following additional parameters required:
host - proxy address
port - proxy port
if your proxy server requires authentication the following additional parameters required:
username - username to authenticate on proxy server
password - password to authenticate on proxy server
domain - (optional) domain to authenticate on proxy server
Example:
s3browser-cli proxy set UserDefined 192.168.2.22 8080
Temp
The Temp object lets you view/edit temp folder location
Available commands are
get,
set.
The get command displays current temp folder location.
To get current temp folder location please use the following syntax:
/temp get
Example:
s3browser-cli /temp get
Output:
C:\Temp\S3 Browser
The set command lets you set new temp folder location
To set temo folder location please use the following syntax:
/temp set path
path - new temp folder location
Example:
s3browser-cli /temp set D:\S3 Browser
Throttling
The Throttling object lets you view/edit bandwidth throttling settings.
Available commands are
get,
set.
The get command displays current bandwidth throttling settings.
To get current bandwidth throttling settings please use type:
/throttling get
Example:
s3browser-cli /throttling get
Output:
Disabled
The set command lets you set new bandwidth throttling settings.
To set bandwidth throttling please use the following syntax:
/throttling set max-kbps-per-thread
max-kbps-per-thread - max KB/s per thread (0 to disable throttling)
Example:
s3browser-cli /throttling set 256
UI
The UI object lets you edit some UI settings
Available commands are
hide-access-keys,
hide-manage-accounts.
The hide-access-keys command lets you
enable masking for Access Key Id and Secret Access Key in Accounts Manager.
To disable access keys visibility in UI please use the following syntax:
/ui hide-access-keys true|false
true|false - true to not show access keys in UI and false otherwise
Example:
s3browser-cli /ui hide-access-keys true
The hide-manage-accounts command lets
you to hide the Manage Accounts.. link in UI.
To hide the Manage Accounts.. link in UI please use the following syntax:
/ui hide-manage-accounts true|false
true|false - true to disable advanced drive properties and false otherwise
Example:
s3browser-cli /ui hide-manage-accounts true
