LinuxCommandLibrary

halp

CLI tool to get help with CLI tools

TLDR

Check help flags for a command
$ halp [command]
copy
Show the manual page or cheat sheet for a command
$ halp plz [command]
copy
Check a specific argument
$ halp --check [--flag] [command]
copy
Set a custom timeout for checking
$ halp -t [10] [command]
copy

SYNOPSIS

halp [options] command
halp plz [options] command

DESCRIPTION

halp is a CLI tool that helps you find the correct help flags for command-line tools. Instead of manually trying -h, --help, -?, help, or other variations, halp checks a predefined list of commonly used help options and reports which ones work for the given command.
The plz subcommand goes further by providing quick access to the manual page or cheat.sh cheat sheet for a command, using your preferred pager.

PARAMETERS

--check ARG

Set the argument to check
--no-version
Disable checking version information
--no-help
Disable checking help information
-c, --config PATH
Set the configuration file
-t, --timeout S
Set the timeout for commands (default: 5 seconds)
-v, --verbose
Enable verbose logging
-h, --help
Print help
-V, --version
Print version

CAVEATS

Some commands may produce side effects when invoked with certain flags, even help-related ones. The default timeout of 5 seconds may be too short for slow commands. Cheat sheet lookups via cheat.sh require an internet connection.

HISTORY

halp was created by Orhun Parmaksiz and is written in Rust. It was designed to eliminate the frustration of guessing which flag a command uses for its help output.

SEE ALSO

man(1), tldr(1), cheat(1)

> TERMINAL_GEAR

Curated for the Linux community

Copied to clipboard