diff --git a/README.md b/README.md index 8ad4c30..502d532 100644 --- a/README.md +++ b/README.md @@ -56,28 +56,58 @@ $ deb-s3 upload my-deb-package-1.0.0_amd64.deb --bucket my-bucket ``` Usage: - deb-s3 upload FILE -b, --bucket=BUCKET + deb-s3 upload FILE Options: - -b, --bucket=BUCKET # The name of the S3 bucket to upload to. + -a, [--arch=ARCH] # The architecture of the package in the APT repository. + -v, [--visibility=VISIBILITY] # The access policy for the uploaded files. Can be public, private, or authenticated. + # Default: public + [--sign=SIGN] # Sign the Release file. Use --sign with your key ID to use a specific key. + -p, [--preserve-versions] # Whether to preserve other versions of a package in the repository when uploading one. + -b, [--bucket=BUCKET] # The name of the S3 bucket to upload to. -c, [--codename=CODENAME] # The codename of the APT repository. # Default: stable -s, [--section=SECTION] # The section of the APT repository. # Default: main - -a, [--arch=ARCH] # The architecture of the package in the APT repository. - -v, [--visibility=VISIBILITY] # The access policy for the uploaded files. Can be public, private, or authenticated. - # Default: public [--access-key=ACCESS_KEY] # The access key for connecting to S3. # Default: $AMAZON_ACCESS_KEY_ID [--secret-key=SECRET_KEY] # The secret key for connecting to S3. # Default: $AMAZON_SECRET_ACCESS_KEY - [--endpoint=AWS_ENDPOINT] # The aws region endpoint for connecting to S3. - [--sign=SIGN] # Sign the Release file. Use --sign with your key ID to use a specific key. - -p, [--preserve-versions] # Whether to preserve other versions of a package in the repository when uploading one. + [--endpoint=ENDPOINT] # The region endpoint for connecting to S3. Uploads the given FILE to a S3 bucket as an APT repository. ``` +You can also verify an existing APT repository on S3 using the `verify` command: + +```console +deb-s3 verify -b my-bucket +>> Retrieving existing manifests +>> Checking for missing packages in: stable/main i386 +>> Checking for missing packages in: stable/main amd64 +>> Checking for missing packages in: stable/main all +``` + +``` +Usage: + deb-s3 verify + +Options: + -f, [--fix-manifests] # Whether to fix problems in manifests when verifying. + -b, [--bucket=BUCKET] # The name of the S3 bucket to upload to. + -c, [--codename=CODENAME] # The codename of the APT repository. + # Default: stable + -s, [--section=SECTION] # The section of the APT repository. + # Default: main + [--access-key=ACCESS_KEY] # The access key for connecting to S3. + # Default: $AMAZON_ACCESS_KEY_ID + [--secret-key=SECRET_KEY] # The secret key for connecting to S3. + # Default: $AMAZON_SECRET_ACCESS_KEY + [--endpoint=ENDPOINT] # The region endpoint for connecting to S3. + +Verifies that the files in the package manifests exist +``` + ## TODO This is still experimental. These are several things to be done: