Skip to content
This repository was archived by the owner on Mar 24, 2020. It is now read-only.

Commit eadb9a8

Browse files
committed
Updated readme
1 parent c372f44 commit eadb9a8

File tree

1 file changed

+38
-8
lines changed

1 file changed

+38
-8
lines changed

README.md

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,28 +56,58 @@ $ deb-s3 upload my-deb-package-1.0.0_amd64.deb --bucket my-bucket
5656

5757
```
5858
Usage:
59-
deb-s3 upload FILE -b, --bucket=BUCKET
59+
deb-s3 upload FILE
6060
6161
Options:
62-
-b, --bucket=BUCKET # The name of the S3 bucket to upload to.
62+
-a, [--arch=ARCH] # The architecture of the package in the APT repository.
63+
-v, [--visibility=VISIBILITY] # The access policy for the uploaded files. Can be public, private, or authenticated.
64+
# Default: public
65+
[--sign=SIGN] # Sign the Release file. Use --sign with your key ID to use a specific key.
66+
-p, [--preserve-versions] # Whether to preserve other versions of a package in the repository when uploading one.
67+
-b, [--bucket=BUCKET] # The name of the S3 bucket to upload to.
6368
-c, [--codename=CODENAME] # The codename of the APT repository.
6469
# Default: stable
6570
-s, [--section=SECTION] # The section of the APT repository.
6671
# Default: main
67-
-a, [--arch=ARCH] # The architecture of the package in the APT repository.
68-
-v, [--visibility=VISIBILITY] # The access policy for the uploaded files. Can be public, private, or authenticated.
69-
# Default: public
7072
[--access-key=ACCESS_KEY] # The access key for connecting to S3.
7173
# Default: $AMAZON_ACCESS_KEY_ID
7274
[--secret-key=SECRET_KEY] # The secret key for connecting to S3.
7375
# Default: $AMAZON_SECRET_ACCESS_KEY
74-
[--endpoint=AWS_ENDPOINT] # The aws region endpoint for connecting to S3.
75-
[--sign=SIGN] # Sign the Release file. Use --sign with your key ID to use a specific key.
76-
-p, [--preserve-versions] # Whether to preserve other versions of a package in the repository when uploading one.
76+
[--endpoint=ENDPOINT] # The region endpoint for connecting to S3.
7777
7878
Uploads the given FILE to a S3 bucket as an APT repository.
7979
```
8080

81+
You can also verify an existing APT repository on S3 using the `verify` command:
82+
83+
```console
84+
deb-s3 verify -b my-bucket
85+
>> Retrieving existing manifests
86+
>> Checking for missing packages in: stable/main i386
87+
>> Checking for missing packages in: stable/main amd64
88+
>> Checking for missing packages in: stable/main all
89+
```
90+
91+
```
92+
Usage:
93+
deb-s3 verify
94+
95+
Options:
96+
-f, [--fix-manifests] # Whether to fix problems in manifests when verifying.
97+
-b, [--bucket=BUCKET] # The name of the S3 bucket to upload to.
98+
-c, [--codename=CODENAME] # The codename of the APT repository.
99+
# Default: stable
100+
-s, [--section=SECTION] # The section of the APT repository.
101+
# Default: main
102+
[--access-key=ACCESS_KEY] # The access key for connecting to S3.
103+
# Default: $AMAZON_ACCESS_KEY_ID
104+
[--secret-key=SECRET_KEY] # The secret key for connecting to S3.
105+
# Default: $AMAZON_SECRET_ACCESS_KEY
106+
[--endpoint=ENDPOINT] # The region endpoint for connecting to S3.
107+
108+
Verifies that the files in the package manifests exist
109+
```
110+
81111
## TODO
82112

83113
This is still experimental. These are several things to be done:

0 commit comments

Comments
 (0)