Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
S3 client and S3 Command Line Interface
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
test
.gitignore
.npmignore
.travis.yml
Makefile
README.md
index.js
package.json

README.md

s3cli

Build Status

  .                .
 / \               |   o
|\ /| .--..--. .-. |   .
| | | `--. --:(    |   |
 \|/  `--'`--' `-' `--' `-
  '

s3cli is S3 client and S3 Command Line Interface.
Inspired by Python's s3cmd.

S3 compatible service

Features

  • Response content is JSON.
  • Debug output Request and Response.
  • Output style is Table or XML or Eyes.
  • CLI is sub command style.

Installation

$ npm install s3cli -g

Usage

CLI

Invoke interactive configuration.

$ s3cli init
$ s3cli mb bucket
$ s3cli use bucket
$ s3cli set object value

Output XML

XML is set to body of response.

$ s3cli lb --raw

Bucket use

Set to config the Bucket name.

$ s3cli lb
$ s3cli use bucket
$ s3cli get object

Recursively

Remove the object recursively

$ s3cli rb bucket
The bucket you tried to delete is not empty
$ s3cli rb bucket -R
Object 'bucket/object' removed
Bucket 'bucket' removed

Program

JSON is set to content of response.

// create client
var s3 = require('s3cli');
var client = s3.createClient({
  host_base: 's3.amazonaws.com',
  access_key: 'ACCESSKEY',
  secret_key: 'SECRETKEY'
});

// bucket list
client.service.buckets(function (err, res) {
  console.dir(res.content.buckets.bucket);
});

// Make bucket
client.buckets.create('bucket', function (err, res) {
  console.log(res.status);
});

// Remove bucket
client.buckets.destroy('bucket', function (err, res) {
  console.log(res.status);
});

// object list
client.buckets.objects('bucket', {prefix: 'a', delimiter: '/'}, function (err, res) {
  console.dir(res.content.content);
});

// Set value of a object from bucket
client.objects.create('bucket', 'object', 'value', {}, function (err, res) {
  console.log(res.status);
});

// Get value of a object from bucket
client.objects.read('bucket', 'object', function (err, res) {
  console.log(res.body);
});

// Delete a object from bucket
client.objects.destroy('bucket', 'object', function (err, res) {
  console.log(res.status);
});

Tests

$ make test

Licence

  • MIT
Something went wrong with that request. Please try again.