loganwalls / hac Goto Github PK

        ,--,                          
      ,--.'|   ,---,         ,----..  
   ,--,  | :  '  .' \       /   /   \ 
,---.'|  : ' /  ;    '.    |   :     :
|   | : _' |:  :       \   .   |  ;. /
:   : |.'  |:  |   /\   \  .   ; /--` 
|   ' '  ; :|  :  ' ;.   : ;   | ;    
'   |  .'. ||  |  ;/  \   \|   : |    
|   | :  | ''  :  | \  \ ,'.   | '___ 
'   : |  : ;|  |  '  '--'  '   ; : .'|
|   | '  ,/ |  :  :        '   | '/  :
;   : ;--'  |  | ,'        |   :    / 
|   ,/      `--''           \   \ .'  
'---'                        `---`    

HAC is an API client like Postman that runs on your terminal. We have the goal of making easy to test and document APIs while being completely offline, free and open source.

• Installation
• Documentation
• Customization
• Contributing
• Changelog

This section should guide you through the hac installation process.

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

You can get hac from crates.io with:

cargo install hac-client

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

Documentation can be found in the hac wiki

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

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

hac --config-dump > hac.toml

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

Changelogs can be found here