s3-manager

README

S3 Manager

TBD

You can provide access credentials of your AWS account with below environment variables or CLI flags. Keep in mind that command line flags will override environment variables if you set both of them:

"--accessKey" CLI flag or "AWS_ACCESS_KEY" environment variable
"--secretKey" CLI flag or "AWS_SECRET_KEY" environment variable
"--region" CLI flag or "AWS_REGION" environment variable
"--bucketName" CLI flag or "AWS_BUCKET_NAME" environment variable

Configuration

Usage:
  s3-manager [flags]
  s3-manager [command]

Available Commands:
  clean       clean subcommand cleans the app, finds and clears desired files
  completion  Generate the autocompletion script for the specified shell
  search      search subcommand searches the files which has desired substrings in it
  configure   configure subcommand configures the bucket level settings
  help        Help about any command

Flags:
      --accessKey string    access key credential to access S3 bucket, this value also can be passed via "AWS_ACCESS_KEY" environment variable (default "")
      --bucketName string   name of the target bucket on S3, this value also can be passed via "AWS_BUCKET_NAME" environment variable (default "")
  -h, --help                help for s3-manager
      --region string       region of the target bucket on S3, this value also can be passed via "AWS_REGION" environment variable (default "")
      --secretKey string    secret key credential to access S3 bucket, this value also can be passed via "AWS_SECRET_KEY" environment variable (default "")
      --verbose             verbose output of the logging library (default false)
  -v, --version             version for s3-manager

Use "s3-manager [command] --help" for more information about a command.

Installation

Binary

Binary can be downloaded from Releases page.

After then, you can simply run binary by providing required command line arguments:

$ ./s3-manager search --accessKey asdasfasfasfasfasfas --secretKey asdasfasfasfasfasfas --bucketName demo-bucket --region us-east-2 --substring "catch me if you can"

Homebrew

This project can also be installed with Homebrew:

$ brew tap bilalcaliskan/tap
$ brew install bilalcaliskan/tap/s3-manager

Then similar to binary method, you can run it by calling below command:

$ s3-manager search --accessKey asdasfasfasfasfasfas --secretKey asdasfasfasfasfasfas --bucketName demo-bucket --region us-east-2 --substring "catch me if you can"

Development

This project requires below tools while developing:

• Golang 1.20
• pre-commit
• golangci-lint - required by pre-commit
• gocyclo - required by pre-commit

Simply run below command to prepare your development environment:

$ python3 -m venv venv
$ source venv/bin/activate
$ pip3 install pre-commit
$ pre-commit install -c build/ci/.pre-commit-config.yaml

Documentation

Overview

Copyright © 2022 bilalcaliskan bilalcaliskan@protonmail.com