Metadata-Version: 2.1
Name: PyHTBcli
Version: 0.0.3
Summary: Command line interface for HackTheBox
Home-page: https://github.com/0xdf223/PyHTBcli
Author: 0xdf
Author-email: 0xdf.223@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.8
Requires-Dist: click (>=8.0.4)
Requires-Dist: click-shell (>=2.1)
Requires-Dist: prettytable (>=3.1.1)
Requires-Dist: PyHackTheBox (>=0.5.4)

# htbcli
HackTheBox Command Line Tool

![](images/htb-list-competitive.png)

# Requirements

## nmcli

VPN is controlled by the `nmcli` program. 

Is installed in most Debian-based Linux distributions by default.

Can be installed with:
```
$ apt-get install network-manager
```

## Fonts

To make the icons print nicely, need a [nerd font](https://www.nerdfonts.com/) installed.

Install instructions (Linux):

```
wget https://github.com/ryanoasis/nerd-fonts/releases/download/v2.1.0/Ubuntu.zip -O /tmp/Ubuntu.zip
mkdir -p ~/.local/share/fonts
unzip /tmp/Ubuntu.zip -d ~/.local/share/fonts
fc-cache -fv
```

# Installation

```bash
pip install PyHTBcli
```

# Shell Auto Complete

To get tab completion in the default linux shell.

## Bash

Add this line to `~/.bashrc`:

```bash
eval "$(_htb_COMPLETE=bash_source htb)"
```

## Zsh

Add this line to `~/.zshrc`:

```bash
eval "$(_HTB_COMPLETE=zsh_source htb)"
```

## Fish

Add this to `~/.config/fish/completions/htb.fish`:

```bash
eval (env _HTB_COMPLETE=fish_source htb)
```

## Full Documention

See [readthedocs](https://pyhtbcli.readthedocs.io/en/latest/) for full documentation.


