gcrane-help

Display help for a subcommand

$ gcrane help [command]

$ gcrane help [[-h|--help]]

gcrane-help

--verbose, -v
    Enables verbose logging output. When used with gcrane-help, it might display additional diagnostic information about the help system itself, or if gcrane-help is a wrapper, it might pass this flag to the underlying gcrane command.

The gcrane-help command serves as the primary entry point for obtaining assistance and documentation regarding the gcrane command-line tool. It provides an overview of gcrane's capabilities, lists its available subcommands (such as auth, cp, pull, push, and delete), and explains their basic usage. Users can consult gcrane-help to understand the overall structure of gcrane and to navigate to specific subcommand help, which is typically accessed by appending --help to the subcommand (e.g., gcrane pull --help). This command is essential for new users to grasp gcrane's functionality and for experienced users to quickly reference available operations and global flags.

While gcrane-help provides general information for the gcrane suite, for detailed usage and specific options of individual subcommands (e.g., gcrane pull or gcrane push), you must use the subcommand's dedicated help, typically by running gcrane <subcommand> --help. gcrane-help itself usually doesn't take specific subcommand arguments.

gcrane is a specialized command-line tool designed for efficient interaction with Google Container Registry (GCR) and Google Artifact Registry. Developed as a more lightweight and focused alternative to broader tools like gcloud or raw docker commands for registry operations, its development prioritizes direct image management tasks like copying, pushing, pulling, and deleting. The integrated help functionality (accessed via gcrane-help or gcrane help) has been a core component from its early stages, ensuring users can quickly ascertain command usage and available options without needing to consult external documentation, thereby enhancing usability and adoption for managing container images in GCP's ecosystem.

gcrane(1), gcloud(1), docker(1)