Skip to content

Commit b3517da

Browse files
authored
Update README.md
1 parent 2f7cc8e commit b3517da

1 file changed

Lines changed: 30 additions & 21 deletions

File tree

README.md

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,8 @@ Usage:
1717
1818
Available Commands:
1919
cat Print content of S3 file(s) to stdout
20-
compliance Add compliance lock
21-
govern Add/remove governance lock
2220
help Help about any command
23-
hold Add/remove legal hold
21+
lock Manage object locks
2422
logs Print S3 Access logs as JSON
2523
size Calculate size of S3 location
2624
@@ -161,14 +159,14 @@ It is also possible to get JSON output:
161159
]
162160
```
163161

164-
## s3kit compliance
162+
## s3kit lock compliance
165163
Adds the [compliance lock](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) to a given object identified by a prefix and applicable to all versions of the object(s), latest version of the object(s) or specific version of the object(s).
166164

167165
```
168166
Add compliance lock
169167
170168
Usage:
171-
s3kit compliance s3://bucket/key1 s3://bucket/prefix/ ... [flags]
169+
s3kit lock compliance s3://bucket/key1 s3://bucket/prefix/ ... [flags]
172170
173171
Flags:
174172
--all Apply to all versions of object(s)
@@ -184,49 +182,60 @@ Global Flags:
184182
This operation will explicitly ask for confirmation prior to applying to the object version, because there's no way to revert the compliance lock:
185183

186184
```
187-
compliance s3://demolocal123/go.mod --expire 10s
185+
s3kit lock compliance s3://demolocal123/go.mod --expire 10s
188186
Locking s3://bucket/key version .oNOa6ZVNDTUcKHaaaECJUmdA9XaBTI4 expires 2020-04-18 15:31:35, proceed? (y/N):
189187
```
190188

191189
The default answer is **NO**.
192190

193-
## s3kit hold add / rm
191+
## s3kit lock legal add / rm
194192

195193
Adds or removes the [legal hold](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) to the object(s) found by given S3 prefix(es).
196194

197195
```
198-
Add/remove legal hold for given object(s)
196+
Add/remove legal hold
199197
200198
Usage:
201-
s3kit hold add s3://bucket/key1 s3://bucket/prefix/ ... [flags]
199+
s3kit lock legal [command]
202200
203-
Flags:
204-
-h, --help help for add
201+
Available Commands:
202+
add Add legal hold for given object(s)
203+
rm Remove legal hold for given object(s)
205204
206-
Global Flags:
205+
Flags:
207206
--all Apply to all versions of object(s)
207+
-h, --help help for legal
208208
--latest Apply to latest version of object(s) (default true)
209209
--version string Apply to a specific version
210-
-w, --workers int number of concurrent threads (default 12)
210+
211+
Global Flags:
212+
-w, --workers int number of concurrent threads (default 12)
213+
214+
Use "s3kit lock legal [command] --help" for more information about a command.
211215
```
212216

213-
## s3kit govern add / rm
217+
## s3kit lock governance add / rm
214218

215219
Adds or removes the [governance retention lock](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) to the object(s) found by given S3 prefix(es).
216220

217221
```
218-
Add/remove governance lock for given object(s)
222+
Add/remove governance lock
219223
220224
Usage:
221-
s3kit govern add s3://bucket/key1 s3://bucket/prefix/ ... [flags]
225+
s3kit lock governance [command]
222226
223-
Flags:
224-
--expire duration governance lock duration (1m, 1h etc)
225-
-h, --help help for add
227+
Available Commands:
228+
add Add governance lock for given object(s)
229+
rm Remove governance lock for given object(s)
226230
227-
Global Flags:
231+
Flags:
228232
--all Apply to all versions of object(s)
233+
-h, --help help for governance
229234
--latest Apply to latest version of object(s) (default true)
230235
--version string Apply to a specific version
231-
-w, --workers int number of concurrent threads (default 12)
236+
237+
Global Flags:
238+
-w, --workers int number of concurrent threads (default 12)
239+
240+
Use "s3kit lock governance [command] --help" for more information about a command.
232241
```

0 commit comments

Comments
 (0)