Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orangekame3/stree
๐Directory trees of AWS S3 Bucket
https://github.com/orangekame3/stree
aws cli go localstack s3
Last synced: about 2 months ago
JSON representation
๐Directory trees of AWS S3 Bucket
- Host: GitHub
- URL: https://github.com/orangekame3/stree
- Owner: orangekame3
- License: mit
- Created: 2023-09-11T14:38:33.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-02-27T11:34:43.000Z (4 months ago)
- Last Synced: 2024-02-27T12:43:28.107Z (4 months ago)
- Topics: aws, cli, go, localstack, s3
- Language: Go
- Homepage:
- Size: 947 KB
- Stars: 86
- Watchers: 3
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Lists
- cli-apps - stree - A CLI tool designed to visualize the directory tree structure of an S3 bucket. (<a name="ls"></a>File listing (alternatives to ls))
- awesome-cli-apps - stree - A CLI tool designed to visualize the directory tree structure of an S3 bucket. (<a name="ls"></a>File listing (alternatives to ls))
README
# ๐stree
Directory trees of S3
# Overview
`stree` is a CLI tool designed to visualize the directory tree structure of an S3 bucket.
By inputting an S3 bucket/prefix and utilizing various flags to customize your request, you can obtain a colorized or non-colorized directory tree right in your terminal.
Whether it's for verifying the file structure, sharing the structure with your team, or any other purpose, `stree` offers an easy and convenient way to explore your S3 buckets.
ๆฅๆฌ่ชใฎ็ดนไป่จไบโ[stree๏ผS3ใใฑใใใtreeใใCLIใณใใณใ](https://future-architect.github.io/articles/20230926a/)
[Community \| AWS open source newsletter, \#189](https://community.aws/content/2cXuki31b6cvPtkoOMdNNxfLKfr/aws-open-source-newsletter-189)
# Features
- **Colorized Output**: By default, `stree` provides a colorized tree structure, making it easy to differentiate between directories and files at a glance. This feature can be turned off with the `-n` or `--no-color` flag.
- **LocalStack Support**: `stree` supports local testing with LocalStack, a fully functional local AWS cloud stack, thanks to the `--local` and `--endpoint-url` flags.
- **Custom AWS Profile and Region**: Specify the AWS profile and region with the `--profile` and `--region` flags to override the default settings as needed.
- **Ease of Installation**: Install `stree` via Go, Homebrew, or by downloading the latest compiled binaries from the GitHub releases page.
- **Depth level Specification**: With the new `--L` flag, you can now specify how many levels deep in the directory structure you'd like to visualize. This offers a more focused view, especially for large S3 buckets.
- **Role Switching Support**: `stree` is now enhanced with the ability to switch AWS roles with MFA using the `--mfa` flag. This makes it easier to manage and view S3 buckets that require different IAM roles for access.
- **Environment Variable Support**: `stree` now prioritizes environment variables for AWS Profile and Region settings. The tool will use the `AWS_PROFILE` environment variable if set, falling back to the `default` profile otherwise. Similarly, it will use the `AWS_REGION` or `AWS_DEFAULT_REGION` environment variables for the AWS region, if available. (see [AWS CLI Environment Variables](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html) for more information)
# Install
## Go
```shell
go install github.com/orangekame3/stree@latest
```
## Homebrew
```shell
brew install orangekame3/tap/stree
```
## Download
Download the latest compiled binaries and put it anywhere in your executable path.
[Download here](https://github.com/orangekame3/stree/releases)
# How to Use
> [!WARNING]
>Prerequisite
>You must set up the config and credentials to be used with aws cli in advance
From here on, it is assumed that the config and credentials are set as follows.
```shell
~/.aws/config
[my_profile]
region = ap-northeast-1
output = json
```
```shell
~/.aws/credentials
[my_profile]
aws_access_key_id=XXXXXXXXXXXXXXXXXXXXX
aws_secret_access_key=XXXXXXXXXXXXXXXXX
```
## Basic Commands
Specify the bucket name and profile, and execute the following command. The profile is specified with `--profile (-p)`.
```shell
stree my-bucket -p my_profile
```
You will get the following output.
```shell
my-bucket
โโโ test
โโโ dir1
โ โโโ dir1_1
โ โ โโโ dir1_1_1
โ โ โโโ file1.csv
โ โ โโโ file2.csv
โ โโโ dir1_2
โ โโโ file1.csv
โ โโโ file2.csv
โ โโโ file3.csv
โโโ dir2
โ โโโ dir2_1
โ โโโ dir2_1_1
โ โโโ file1.csv
โ โโโ file2.csv
โ โโโ file3.csv
โโโ dir3
โโโ file1.csv
โโโ file2.csv
9 directories, 10 files
```
## Specifying Prefix
```shell
stree my-bucket/test/dir2 -p my_profile
```
The result of executing this command is as follows.
```shell
my-bucket
โโโ test
โโโ dir2
โโโ dir2_1
โโโ dir2_1_1
โโโ file1.csv
โโโ file2.csv
โโโ file3.csv
4 directories, 3 files
```
## Overriding Region
You can specify the region with `--region (-r)`. Use the `--region` flag to override when you want to specify a region other than the one listed in the profile.
## Usage with Localstack
It can also be used with Localstack. When using it with Localstack, the endpoint and region are set to the following by default.
```shell
endpoint = http://localhost:4566
region = us-east-1
```
Since the majority of cases are expected to use the above settings, we have added a flag for Localstack, which is `--local (-l)`.
```shell
stree my-bucket/test/dir2 -l
```
In case you need to change the endpoint and region due to special circumstances, you can override with `--region (-r)` flag and `--endpoint (-e)`.
```shell
stree my-bucket/test/dir2 -r us-east-1 -e http://localhost:4537
```
## Disable Color Output
You can disable color output with `--no-color (-n)`.
With color
Without color
## Specifying Depth Level
You can specify the depth level with `--level (-L)`. The default is 0, which means that all directories are displayed.
```shell
stree my-bucket -p my_profile -L 3
my-bucket
โโโ test
โโโ dir3
โ โโโ file1.csv
โ โโโ file2.csv
โโโ dir1
โ โโโ dir1_1
โ โโโ dir1_2
โโโ dir2
โโโ dir2_1
```
## Role Switching Support
You can switch roles with MFA using the `--mfa` flag. This makes it easier to manage and view S3 buckets that require different IAM roles for access.
To use this feature, you must first set up the config and credentials to be used with aws cli in advance.
```shell
[profile dev_david]
source_profile = my_profile
# MFA device
mfa_serial = arn:aws:iam::820544363308:mfa/david_mfa_device
# Role to assume
role_arn = arn:aws:iam::820544363308:role/david_role
```
see [Assume AWS IAM Roles with MFA Using the AWS SDK for Go](https://aws.amazon.com/jp/blogs/developer/assume-aws-iam-roles-with-mfa-using-the-aws-sdk-for-go/) for more information
And then execute the following command.
```shell
stree my-bucket -p dev_david -mfa
```
Also, if you wish to operate with a profile that assumes a role, you can specify it using the `--profile (-p)` flag, without the need for MFA.
```shell
[profile dev_david]
source_profile = my_profile
# Role to assume
role_arn = arn:aws:iam::820544363308:role/david_role
```
And then execute the following command.
```shell
stree my-bucket -p dev_david
```
# Usage
```shell
Usage:
stree [bucket/prefix] [flags]
Flags:
-e, --endpoint-url string AWS endpoint URL to use (useful for local testing with LocalStack)
-h, --help help for stree
-L, --level int Descend only level directories
-l, --local Use LocalStack configuration
-m, --mfa Use Multi-Factor Authentication
-n, --no-color Disable colorized output
-p, --profile string AWS profile to use (default "default")
-r, --region string AWS region to use (overrides the region specified in the profile)
```
# License
`stree` is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
# Acknowledgments
The concept of "stree" was inspired by the pioneering work seen in [gtree](https://github.com/ddddddO/gtree). I'm grateful for the inspiration.