A CLI tool to get help with CLI tools 🐙

Have you ever experienced this:

$ some_tool -v
unknown flag -v

$ some_tool -V
unknown flag -V

$ some_tool -h
unknown flag -h

$ asdjw1jwhdajh1idojad # frustration
bash: asdjw1jwhdajh1idojad: command not found

$ some_tool --help
Some CLI Tool Version 1.42.69
Usage:
  some_tool <flags> <args> [--parameter1 value1 --parameter2 value2 ...]

# f*cking finally!

halp aims to help with this and other different cases.

Installation

Packaging status

Cargo

halp can be installed from crates.io:

cargo install halp

The minimum supported Rust version is 1.64.0.

Arch Linux

halp can be installed from available AUR packages using an AUR helper. For example,

paru -S halp

If you prefer, you can clone the package and then build it with makepkg. For example,

git clone https://aur.archlinux.org/halp.git && cd halp && makepkg -si

Docker

Images

Docker builds are automated and images are available in the following registries:

• Docker Hub
• GitHub Container Registry

Usage

The following commands can be used to get help for a binary inside the container:

docker run --rm -it "orhunp/halp:${TAG:-latest}" whoami
docker run --rm -it "orhunp/halp:${TAG:-latest}" plz whoami

Or you can provide a custom binary as follows (please note that you might get shared library errors):

docker run -v "bin:/app/bin:rw" --rm -it "orhunp/halp:${TAG:-latest}" -v ./bin

Building

Custom Docker images can be built from the Dockerfile:

docker build -t halp .

Binary releases

See the available binaries for different targets from the releases page. They are are automated via Continuous Deployment workflow

Release tarballs are signed with the following PGP key: 0xFB41AE0358378256

Build from source

1. Clone the repository.

git clone https://github.com/orhun/halp && cd halp/

2. Build.

CARGO_TARGET_DIR=target cargo build --release

Binary will be located at target/release/halp.

Usage

Configuration

License

^{Licensed under either of Apache License, Version 2.0 or MIT license at your option.}
_{Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this program by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.}