Skip to content

Commit 1675c98

Browse files
committed
Update README.md
1 parent 57f2e20 commit 1675c98

1 file changed

Lines changed: 48 additions & 1 deletion

File tree

README.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
## Purpose
22

3-
Simplify getting some basic statistics about content of AWS S3 buckets, that are missing or not very convenient to use in AWS CLI. Manage object locks/compliances. The missing parts of `aws s3`.
3+
Simplify getting some basic statistics about content of AWS S3 buckets, that are missing or not very convenient to use in AWS CLI. Supports the following commands:
4+
5+
|Command | Description|
6+
| -------- |:-----------|
7+
| **cat** | Print content of S3 file(s) to stdout|
8+
| **help** | Help about any command |
9+
| **lock** | Manage object locks |
10+
| **logs** | Print S3 access logs as JSON |
11+
| **ls** | List versions and/legal holds and locks |
12+
| **parquet** | Parquet files explorer |
13+
| **size** | Calculate size of S3 location |
14+
| **tag** | Tag S3 object(s) |
415

516
Could be quite useful for a fellow data engineer.
617

@@ -328,3 +339,39 @@ Global Flags:
328339
-w, --workers int number of concurrent threads (default 12)
329340
--yaml YAML output
330341
```
342+
343+
### s3kit tag add
344+
```
345+
Add tag(s) to S3 object(s)
346+
347+
Usage:
348+
s3kit tag add s3://bucket/folder/ s3://bucket/folder/prefix ... [flags]
349+
350+
Flags:
351+
-h, --help help for add
352+
--tags strings tags as --tags 'tag1=value1,tag2=value2' or multiple --tags ... options
353+
354+
Global Flags:
355+
--all Apply to all versions of object(s)
356+
--latest Apply to latest version of object(s) (default true)
357+
--version string Apply to a specific version
358+
-w, --workers int number of concurrent threads (default 12)
359+
```
360+
361+
### s3kit tag rm
362+
```
363+
Remove tag(s) from S3 object(s)
364+
365+
Usage:
366+
s3kit tag rm s3://bucket/folder/ s3://bucket/folder/prefix ... [flags]
367+
368+
Flags:
369+
-h, --help help for rm
370+
--tags strings tags as --tags 'tag1,tag2' or multiple --tags ... options
371+
372+
Global Flags:
373+
--all Apply to all versions of object(s)
374+
--latest Apply to latest version of object(s) (default true)
375+
--version string Apply to a specific version
376+
-w, --workers int number of concurrent threads (default 12)
377+
```

0 commit comments

Comments
 (0)