# s3scan

**Repository Path**: mirrors_mapbox/s3scan

## Basic Information

- **Project Name**: s3scan
- **Description**: S3 can! - Provides native Node.js streams for S3 operations.
- **Primary Language**: Unknown
- **License**: ISC
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2025-10-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://travis-ci.org/mapbox/s3scan.svg?branch=master)](https://travis-ci.org/mapbox/s3scan)

# s3scan

Provides native Node.js streams for S3 operations such as
- listing all the keys in a bucket/prefix
- retrieving all the objects under a given bucket/prefix
- deleting all the children of a given bucket/prefix

Also provides CLI tools:

**s3keys**: prints a line-delimited list of keys to stdout

```sh
$ s3keys s3://my-bucket/some-prefix
```

**s3purge**: deletes all objects beneath the provided prefix

```sh
$ s3purge s3://my-bucket/all-finished-with-these
```

**s3scan**: GET and print a prefix-worth of objects to stdout

```sh
$ s3scan s3://my-bucket/some-prefix
$ s3scan s3://my-bucket/some-prefix --gunzip
$ s3scan s3://my-bucket/some-prefix --gunzip --concurrency=1
```

## Running tests

You can run tests against your own bucket/prefix by specifying them as environment variables:

```
TestBucket=my-bucket TestPrefix=my-prefix npm test
```

Otherwise these values default to buckets owned by Mapbox which require appropriate authentication.