diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..004f9da --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +s3tree diff --git a/README.md b/README.md index e0f4dfa..5719a0f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,11 @@ s3tree ### Installation: ```sh -$ go get github.com/a8m/s3tree +$ go install github.com/kk17/s3tree@latest +``` +for golang version less than 1.8: +```sh +$ go get github.com/kk17/s3tree ``` ### How to use ? @@ -12,7 +16,14 @@ $ go get github.com/a8m/s3tree $ s3tree -b bucket-name -p prefix(optional) [options...] ``` Remember, your credentials should located at `~/.aws/credentials` or as an environment variables: -`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` +`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_DEFAULT_REGION` + +### Develop +```sh +go get +go build +./s3tree xxx +``` ### License MIT diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..a5590e1 --- /dev/null +++ b/go.mod @@ -0,0 +1,10 @@ +module github.com/kk17/s3tree + +go 1.20 + +require ( + github.com/a8m/tree v0.0.0-20230208161321-36ae24ddad15 + github.com/aws/aws-sdk-go v1.44.245 +) + +require github.com/jmespath/go-jmespath v0.4.0 // indirect diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..823c1b7 --- /dev/null +++ b/go.sum @@ -0,0 +1,40 @@ +github.com/a8m/tree v0.0.0-20230208161321-36ae24ddad15 h1:t3qDzTv8T15tVVhJHHgY7hX5jiIz67xE2SxWQ2ehjH4= +github.com/a8m/tree v0.0.0-20230208161321-36ae24ddad15/go.mod h1:j5astEcUkZQX8lK+KKlQ3NRQ50f4EE8ZjyZpCz3mrH4= +github.com/aws/aws-sdk-go v1.44.245 h1:KtY2s4q31/kn33AdV63R5t77mdxsI7rq3YT7Mgo805M= +github.com/aws/aws-sdk-go v1.44.245/go.mod h1:aVsgQcEevwlmQ7qHE9I3h+dtQgpqhFB+i8Phjh7fkwI= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9YPoQUg= +github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo= +github.com/jmespath/go-jmespath/internal/testify v1.5.1/go.mod h1:L3OGu8Wl2/fWfCI6z80xFu9LTZmf1ZRjMHUOPmWr69U= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/net v0.1.0/go.mod h1:Cx3nUiGt4eDBEyega/BKRp+/AlGL8hYe7U9odMt2Cco= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.1.0/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= diff --git a/s3tree.go b/s3tree.go index c735c2d..80c1b1b 100644 --- a/s3tree.go +++ b/s3tree.go @@ -4,11 +4,13 @@ import ( "errors" "flag" "fmt" + "os" + "strings" + "github.com/a8m/tree" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/s3" - "os" ) var ( @@ -34,7 +36,7 @@ var ( // S3 args bucket = flag.String("b", "", "") prefix = flag.String("p", "", "") - region = flag.String("region", "us-east-1", "") + region = flag.String("region", getenv("AWS_DEFAULT_REGION", "us-east-1"), "") ) var usage = `Usage: s3tree -b bucket-name -p prefix(optional) [options...] @@ -43,7 +45,7 @@ Options: --------- S3 options ---------- -b s3 bucket(required). -p s3 prefix. - --region name aws region(default to us-east-1). + --region name aws region(default to env variable AWS_DEFAULT_REGION or us-east-1). ------- Listing options ------- -a All files are listed. -d List directories only. @@ -68,16 +70,28 @@ Options: ------- Graphics options ------ -i Don't print indentation lines. -C Turn colorization on always. + [s3 url] s3 url to list objects. ` func main() { flag.Usage = func() { fmt.Fprint(os.Stderr, usage) } flag.Parse() - var noPrefix = len(*prefix) == 0 - if len(*bucket) == 0 { - err := errors.New("-b(s3 bucket) is required.") - errAndExit(err) + if flag.NArg() != 0 { + bucket0, prefix0 := s3urlToBucketAndPrefix(flag.Arg(0)) + if len(*bucket) != 0 || len(*prefix) != 0 { + err := errors.New("s3 bucket and prefix are already set by path.") + errAndExit(err) + } + bucket = &bucket0 + prefix = &prefix0 + } else { + if len(*bucket) == 0 { + err := errors.New("-b(s3 bucket) is required.") + errAndExit(err) + } } + var noPrefix = len(*prefix) == 0 + svc := s3.New(session.New(&aws.Config{Region: region})) spin := NewSpin() resp, err := svc.ListObjects(&s3.ListObjectsInput{ @@ -161,3 +175,32 @@ func errAndExit(err error) { fmt.Fprintf(os.Stderr, "s3tree: \"%s\"\n", err) os.Exit(1) } + +// split an aws s3 url into bucket and prefix. The code is used when parsing the s3 url from the command line. +// Usage: +// +// s3url := "s3://mybucket/myfolder" +// bucket, prefix := s3urlToBucketAndPrefix(s3url) +// fmt.Println(bucket, prefix) +// +// Output: +// +// mybucket myfolder +func s3urlToBucketAndPrefix(s3url string) (bucket, prefix string) { + // Remove s3:// + s3url = strings.TrimPrefix(s3url, "s3://") + // Split into bucket and prefix + parts := strings.SplitN(s3url, "/", 2) + if len(parts) == 1 { + return parts[0], "" + } + return parts[0], parts[1] +} + +func getenv(key, fallback string) string { + value := os.Getenv(key) + if len(value) == 0 { + return fallback + } + return value +}