#docker #registry #cli

app dredge-tool

A Command Line tool for interracting with the Docker Registry API

2 stable releases

1.1.0 Oct 3, 2023
1.0.0 Oct 2, 2023

#757 in Command line utilities

MIT/Apache

55KB
865 lines

dredge

Dredge is a command line tool for working with the Docker Registry V2 API.

Usage

Dredge is a command line tool for working with the Docker Registry V2 API.

Usage: dredge [OPTIONS] <REGISTRY> <COMMAND>

Commands:
  catalog  Fetch the list of available repositories from the catalog
  tags     Fetch the list of tags for a given image
  show     Show detailed information about a particular image
  delete   Delete a tagged image from the registry
  check    Perform a simple API Version check towards the configured registry endpoint
  help     Print this message or the help of the given subcommand(s)

Arguments:
  <REGISTRY>
          The host or host:port or full base URL of the Docker Registry

Options:
      --log-level[=<LEVEL>]
          [default: info]
          [possible values: trace, debug, info, warn, error, off]

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

Checking the API Version

Perform a simple API Version check towards the registry endpoint

Usage: dredge <REGISTRY> check

Options:
  -h, --help  Print help

Fetch Repository List

Fetch the list of available repositories from the catalog

Usage: dredge <REGISTRY> catalog

Options:
  -h, --help  Print help

Listing tags for an image

Fetch the list of tags for a given image

Usage: dredge <REGISTRY> tags <NAME>

Arguments:
  <NAME>  

Options:
  -h, --help  Print help

Viewing details of a tagged image

Show detailed information about a particular image

Usage: dredge <REGISTRY> show <IMAGE> [TAG]

Arguments:
<IMAGE>  
[TAG]

Options:
-h, --help  Print help

Deleteing a tagged image

Delete a tagged image from the registry

Note! This requires that the registry has storage delete rights enabled. For example, when creating the registry, setting the environment variable REGISTRY_STORAGE_DELETE_ENABLED=true to enable that feature. If that is not enabled, a MethodNotAllowed error will be returned.

Note! This will only remove the tag from the registry, it will not remove orphaned digests. For that, the garbage collector on the registry service must be run separately.

Usage: dredge <REGISTRY> delete <IMAGE> <TAG>

Arguments:
<IMAGE>  
<TAG>

Options:
-h, --help  Print help

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~10–26MB
~423K SLoC