ListS3

Summary

lists3 is a light-weight CLI tool to create a file browser for S3 buckets provisioning bucket listing.

Download pre-compiled OS specific executable

macOS (Intel)

curl -o lists3-darwin-amd64.tar.gz -LH "Accept: application/octet-stream" "https://github.com/thevickypedia/lists3/releases/latest/download/lists3-darwin-amd64.tar.gz"

macOS (M1)

curl -o lists3-darwin-arm64.tar.gz -LH "Accept: application/octet-stream" "https://github.com/thevickypedia/lists3/releases/latest/download/lists3-darwin-arm64.tar.gz"

Linux

curl -o lists3-linux-amd64.tar.gz -LH "Accept: application/octet-stream" "https://github.com/thevickypedia/lists3/releases/latest/download/lists3-linux-amd64.tar.gz"

Windows (curl)

curl -o lists3-windows-amd64.zip -LH "Accept: application/octet-stream" "https://github.com/thevickypedia/lists3/releases/latest/download/lists3-windows-amd64.zip"

Windows (Invoke-WebRequest)

Invoke-WebRequest -Uri https://github.com/thevickypedia/lists3/releases/latest/download/lists3-windows-amd64.zip -OutFile lists3-windows-amd64.zip

Arguments

• --bucket / -b: Bucket name for which listing has to be created.
• --region / -r: Region name where the bucket is present. Fallback: Default Region
• --filter / -f: S3 prefix to filter (eg: ["github/"]) Fallback: []
• --ignore / -i: Objects to be ignored (eg: ["github/.DS_Store"]) Fallback: []
• --object / -o: Object name to upload in s3 (eg: list.html) Fallback: list
• --proxy / -p: Proxy server's path (eg: https://example.com/proxy) Fallback: https://jarvis.vigneshrao.com/proxy
• --style / -s: Styling for the UI (eg: vanilla) Fallback: bootstrap

Sample

./lists3 --bucket thevickypedia.com --object list --filter '["github/"]' --ignore '["github/.DS_Store"]'

./lists3 --bucket thevickypedia.com --object list --filter '["github/"]'

Crate

https://crates.io/crates/lists3

Cargo Docs - Official Runbook

https://docs.rs/lists3/latest/lists3

Generator

cargo doc --document-private-items --no-deps

Linting

Requirement

rustup component add clippy

Usage

cargo clippy --no-deps --fix

License & copyright

© Vignesh Rao

Licensed under the MIT License