LinuxCommandLibrary

koji-help

Display Koji command help

TLDR

Display all available commands

$ koji help
copy

Display help for specific category (Available categories are: admin, all, bind, build, download, info, misc, monitor, search)
$ koji help [category]
copy

Display help
$ koji help [[-h|--help]]
copy

SYNOPSIS

koji-help [koji_command [koji_subcommand]]

DESCRIPTION

The koji-help command is a utility designed to provide detailed help information for the various commands and subcommands available within the Koji command-line interface (CLI). Koji is a powerful, open-source build system primarily used by Fedora and Red Hat to build RPM packages.

Unlike most commands that have their own set of options, koji-help typically takes a Koji command or subcommand as its argument and then displays the specific help message for that Koji component. This includes a description of the command's purpose, its synopsis, and a list of its available options and arguments.

It serves as a convenient entry point for users to quickly understand the functionality and usage of specific Koji operations without needing to consult extensive documentation manually. While koji --help or koji <command> --help often provide similar information, koji-help can offer a consistent way to access this documentation.

CAVEATS

The output of koji-help depends on the installed Koji client version and available plugins. The information provided can often be obtained directly via koji --help or koji command --help, potentially making koji-help redundant in some environments. It requires the Koji client to be properly installed and configured to function correctly.

USAGE EXAMPLES

To get general help on the Koji client and a list of available commands:
koji-help

To get detailed help on a specific Koji command, such as build:
koji-help build

This will display the synopsis, description, and available options for the build command, helping users understand its various arguments and flags.

HISTORY

The Koji build system, developed by Red Hat, has been a cornerstone for building RPM packages for Fedora and other Red Hat-derived distributions for many years. The koji-help utility was introduced as part of the Koji client tools to streamline access to its extensive command documentation, evolving alongside the various features and commands added to the Koji CLI.

SEE ALSO

koji(1), man(1), help(1)

Copied to clipboard