hac-client 0.1.0

your handy API client, on your terminal!
Documentation

HAC

HAC is a API Client, much like Postman or Insomnia, but for your terminal. hac has the goal of providing a good experience for testing APIs without the need of creating an account. It is completely offline, free and open source.

Preview

this section will be filled with more examples soon

Table of contents

Installation

This section should guide you through the installation process and how to use hac.

You can get hac with cargo, or get the latest release tag.

Installing with cargo

[!NOTE] you need rust v1.76 or newer

You can get hac from crates.io with:

cargo install hac

Building from source

Clone the repository into your machine, and you'll be able to run, or build by following the steps below:

git clone https://github.com/wllfaria/hac
cd hac
cargo run

# alternatively, you can run:
cargo build --release
# or if you have just:
just build
# the binary will be located at target/release/hac

[!IMPORTANT] hac is in its very early stages of development, new features are added constantly, and we have many features planned, feel free to report any bugs, ask for features or discuss ideas.

Documentation

[!NOTE] Documentation is still a work in progress

Documentation can be found in the hac wiki

Customization

Customizing hac is as simple as editing toml files on the config directory, which can be in different places based on your system and maybe in your environment variables, but you can run the following command to know where hac is looking for your configuration:

# this command will print the path to the configuration directory hac is trying to load
hac --config-dir

[!NOTE] You can check all the configuration options and what they mean in the wiki secion for customizing hac

hac comes with a set of default configurations, you can check more on the wiki, or if you prefer, you can dump the default configuration and colorscheme to the configuration directory by using:

hac --config-dump

# alternatively, you can specify a path

hac --config-dump <path>

Contributing

All contributions are welcome! Just open a pull request. Please read CONTRIBUTING.md

Changelog

Changelogs can be found here