download free 30 days trial version buy bucket explorer
Documentation  Download  Purchase  Support  FAQs   Forum   ScreenShots & Demos

How to run Bucket Commander: A command line interface for Amazon S3?

Bucket Commander is a command line tool for Amazon S3. Bucket Explorer does all operations manually but Bucket Commander helps you in Scheduling and Automation of upload/download/copy/setacltodefault features. Here, Automation means that the scheduled operations will be carried on automatically as per configured in the schedule so you can use Bucket Commander instead of Bucket Explorer when you want to schedule a big process.

Bucket Commander needs a configuration file which can be created using Bucket Explorer's UI or manually.

Bucket Commander takes four arguments. " -action ", " -authenticate ”, " -emailprofile ” and " -configfilename "
How to configure Bucket Commander?
  1. Action:

    Valid values for "-action" are:

    • upload
    • download
    • copy
    • setaclstodefault
    • activate
    • profile
    • proxy
    • threadcount
    • smtp-profile
    • multipartsize
  1. Authenticate:

    This argument will be optional if only one credential is saved for "-authenticate". Specify the nickname that you specified at the time of saving credentials.

    To run Bucket Commander, at least one credential should be saved. If you run Bucket Commander for the first time, then you need to update/create authentication tag in BucketExplorer.xml file.

  2. Emailprofile:

    -emailprofile is an optional argument. You need to specify it only when you have configured the Email profile for getting report of Bucket Commander operations (Upload, Download, and Copy) via Email. To create/update Email profile, you need to update SMTPServer tag in BucketExplorer.xml file. Follow the given link to configure BucketExplorer.xml file.

  3. Configfilename:

    -configfilename is an optional argument. This will take full path of commander configuration file saved on your system. This will perform commander operation according to Upload, Download, and Copy content saved in the specified file. If this argument is not being specified, then Bucket Commander will perform operation according to default “BucketCommander.xml” that exists in config folder. If the commander configuration file, that have been supplied through –configfilename argument, does not exist on your system, Bucket Commander will create a blank file with supplied name and with proper message at commander will exit.

For Bucket Commander to work, it needs:
  1. “Config” folder and .Lic file for Bucket Commander. Config folder contains “BucketCommander.xml” and “Bucketexplorer.xml”. Upload/Download/Copy details are picked from the commander xml and authentication details are picked from Bucket Explorer xml.
  2. If use wants to create commander configuration file using Edit commander config option, then it needs to have .lic file for Bucket Explorer UI.
  3. If you do not have .Lic file for Bucket Commander, then Bucket Commander will ask you to download trial license or activate Bucket Commander. Once you are able to activate Bucket Commander, then BucketCommander.lic file will be downloaded at home directory.
  4. To download license file for Bucket Commander, you will be asked to use proxy setting. If you enter yes, it will ask for proxy setting details such as port address, host address, username, password, and domain name.
Commands required to run an operation:
  1. If you want to use default configuration file, i.e. BucketCommander.xml:
    -action: upload/download/copy/setacltodefault [-authenticate: saved credentials] [-emailprofile: emailprofile-name] [-bucketname: name-of-bucket-on-which-default-acl-set]
  2. If you want to use other than the default configuration file:
    To run Bucket Commander, there is a default BucketCommander.xml file. You can also create the same configuration file with different name at your desired location. You can create this file manually or by using Edit Commander config option using Bucket Explorer.
  3. -action: upload/download/copy/setacltodefault [-authenticate: saved credentials] [-emailprofile: emailprofile-name] [-configfilename: full path of commander configuration file] [-bucketname: name-of-bucket-on-which-default-acl-set]

If you want to Create/Edit commander configuration file manually, then you must know the format of commander configuration file.

The format has been described at - How to Set Configuration for Bucket Commander Manually?
To configure Email Profile, please refer to this page - How to send report with bucket commander?
You can specify more than one Email Profile using comma separator for getting report of Bucket Commander Operations via email to each specified profile.

NOTE: If you changed your saved credentials (Access Key or Secret Key), it will prompt you with a message to update your credentials. You need to update saved credentials by giving the changed Access Key and Secret Key.

If BucketCommander.exe runs on different machines, it will not be able to decrypt your save credentials so it will prompt you with a message to update saved credentials. You need to update credentials by giving Access Key and Secret Key.

An example of a working command looks like:

Command on Windows

BucketCommander.exe -action: upload/download/copy [-authenticate: nick-name] [-emailprofile: profilename1, profilename2] [-configfilename: full path of commander configuration file]
Or
BucketCommander.exe -action: setacltodefault [-authenticate: nick-name] [-bucketname: name-of-bucket-on-which-default-acl-set]

Command on Linux

sh BucketCommander.sh/BucketCommander-jre.sh -action: upload/download/copy [-authenticate: nick-name] [-emailprofile: profilename1, profilename2] [-configfilename: full path of commander configuration file]
Or
sh BucketCommander.sh/BucketCommander-jre.sh -action: setacltodefault [-authenticate: nick-name] [-bucketname: name-of-bucket-on-which-default-acl-set]
Note: On Linux you can open terminal at Applications->Accessories->Terminal

Command on Mac OSX

java -jar BucketCommander.jar -action: upload/download/copy [-authenticate: nick-name] [-emailprofile: profilename1, profilename2] [-configfilename: full path of commander configuration file]
Or
java -jar BucketCommander.jar -action: setacltodefault [-authenticate: nick-name] [-bucketname: name-of-bucket-on-which-default-acl-set]
Note: On Mac OSX, you can open terminal at Applications->Utilities->Terminal in Finder.