A command line utility that allows you to stream data from multiple S3 objects directly into your terminal.
This utility is particularly useful when you are storing data in S3 and you want to easily process the content of your S3 objects from your command line, for instance if you are storing your CloudTrail logs in an S3 buckets and you want to grep over them you can do something like this:
s3st mybucket AWSLogs/123456789/CloudTrail/eu-west-1/2019/01/17/ | jq . | grep "lambda"
By default the command line will be able to decompress most compressed files in realtime (gzip, brotli and deflate).
There are several ways to install
Install global with NPM
(Requires Node v10+):
npm i -g s3st
Alternatively you can download one of the pre-compiled binaries for linux, windows, mac or alpine from the Releases page.
These binaries do not require you to have Node installed.
npx (use without install)With
npx s3st some-s3-bucket
Usage: s3st [options] <bucket> [prefix] Options: -v, --version output the version number -D, --do-not-decompress Do not try to decompress files automatically (gzip, deflate, brotli) -h, --help output usage information
bucket represents the name of the bucket to iterate over
prefix is an optional argument that you can pass to select a subset of object
that match the given prefix.
The command will automatically try to decompress compressed files based on their extension, as per the following mapping:
.gzip: decompress using gzip
.deflate: decompress using deflate
.brotli: decompress using brotli (available only if using Node v11.7+)
If you want to disable this option you can specify the flag
The tool will assume you have the proper environment variables or configuration files properly set as per the AWS CLI documentation in order to authenticate requests to AWS.
This package can also be used programmatically as per the following example:
'use strict' const createS3stStream = require('s3st') const AWS = require('aws-sdk') // creates an s3 client using the AWS SDK const s3 = new AWS.S3() const stream = createS3stStream(s3, 'mybucket', 'some-prefix') stream.pipe(process.stdout) // attach the stream to standard output
createS3stStream exposes accepts the following arguments:
s3: an s3 client instance from the AWS SDK or a compatible implementation
bucketName: the name of the bucket
prefix(optional): an object prefix to filter objects in the bucket
transform(optional): a function that allows you to transform the content of objects as they get streamed (useful for instance for decompression or decryption).
If you want to provide a custom transform function, it should respect the following signature.
key(string): the name of the current object (object key)
Transformstream that manipulates the object
If you want to use the default decompression implementation available by the
default in the command line client, you can import that from
Data Transfer costs
If you are using this tool to stream large amount of data be aware that this might have an impact on your data transfer costs. In such cases, using an alternative approach like S3 Select, could be a way to save on cost.
Make sure you are aware of alternatives and that you make careful costs considerations before running any heavy workload in the cloud.
Everyone is very welcome to contribute to this project. You can contribute just by submitting bugs or suggesting improvements by opening an issue on GitHub.
You can also submit PRs as long as you adhere with the code standards and write tests for the proposed changes.
Licensed under MIT License. © Luciano Mammino.