cls3

README

cls3

The description in Japanese is available on the following blog page. -> Blog

What is

CLI tool to clear (so delete all objects and versions/delete-markers in) Amazon S3 Buckets(AWS). The bucket itself can also be deleted by the option.

Install

• Homebrew

  brew tap go-to-k/tap
  brew install go-to-k/tap/cls3
  

• Binary
  • Releases
• Git Clone and install(for developers)

  git clone https://github.com/go-to-k/cls3.git
  cd cls3
  make install
  

How to use

cls3 -b <bucketName> [-p <profile>] [-r <region>] [-f|--force]

• -b, --bucketName: required
  • Bucket name
• -p, --profile: optional
  • AWS profile name
• -r, --region: optional(default: ap-northeast-1)
  • AWS Region
• -f, --force: optional
  • ForceMode (Delete the bucket together)

Documentation

Index

• Constants
• Variables
• func NewLogger(isDebug bool)
• type App
  • func NewApp(version string) *App
  • func (app *App) Run(ctx context.Context) error
• type S3Wrapper
  • func NewS3Wrapper(client client.IS3) *S3Wrapper
  • func (s3Wrapper *S3Wrapper) ClearS3Objects(bucketName string, forceMode bool) error

Constants

const AppName = "cls3"

Variables

var Logger *zerolog.Logger

var Revision = ""

var SleepTimeSecForS3 = 10

var Version = ""

Functions

func NewLogger

func NewLogger(isDebug bool)

Types

type App

type App struct {
	Cli        *cli.App
	BucketName string
	Profile    string
	Region     string
	ForceMode  bool
}

func NewApp

func NewApp(version string) *App

func (*App) Run

func (app *App) Run(ctx context.Context) error

type S3Wrapper

type S3Wrapper struct {
	// contains filtered or unexported fields
}

func NewS3Wrapper

func NewS3Wrapper(client client.IS3) *S3Wrapper

func (*S3Wrapper) ClearS3Objects

func (s3Wrapper *S3Wrapper) ClearS3Objects(bucketName string, forceMode bool) error