Skip to main content

A command line client and library to interact with the website

Project description


HTBClient is a python module and a command line clinet that interfaces with the via their REST API. Since their API doesn't appear to be complete there are features that are currently missing such as challenges. These will be added once they have REST endpoints but I have decided not to implement them now by scraping the site as I felt that would be too fragile and would add a significant amount of throw away code.

Overview Video

View a demonstration video on YouTube


There are several options for installation, i'll cover the common ones below.

Installation of the latest version in PyPi via pip

python3 -m pip install htbclient

Installation of the latest version in the github repository

python3 -m pip install git+


HTBClient can be used as a stand-alone script or imported into your own project. An example of this is my htb-repo project which is a skeleton that I use to organize all the various challenges and boxes from This repo works by having a basic folder layout to organize challenges and machines, then it uses the HTBClient to connect to the websites REST API and creates a folder for each machine that is found on the site but not on the file system, it also creates some metadata files and scripts to help with tracking and controlling the machines. To find out more about the htb-repo project click on this link to visit the repository.

Setting Username/Password

If you are using HTBClient as a module then you need to pass the username and password when you create your instance. When using HTBClient as a module it is recommended that you get your username and password from an environmental variable or some place other than hard-coding it in your source that way if you source is shared you do not accidentally publish your credentials as well.

when running the htb command from the terminal you should set your credentials as environmental variables then run the htb command as shown below


export HTB_PASS=2jli9z9e2l34jlz98890@skx9!2a&
htb <arguments>

Command Line Tool

The command line tool htb has the following options

--assigned          # Show your currently assigned machine
--list all          # Show all machines
--list todo         # Show machines in your todo list
--list spawned      # Show all machines that are currently running
--list active       # Show all machines that have not been retired
--list retired      # Show all machines that have been retired
--list owned        # Show all machines that you have gotten root and user on
--list roots        # Show all machines that you have gotten root on
--list users        # Show all machines that you have gotten user on
--list incomplete   # Show all machines that you have not yet owned
--start <machine>   # Start the specified machine
--stop              # Stop the machine assigned to you
--reset <machine>   # Restart the specified machine
--todo <machine>    # Toggle the specified machines todo status
--username <user>   # HTB Username (only needed if you don't use variables)
--password <pass>   # HTB Password (only needed if you don't use variables)

The command line tool is installed into the systems path as htb so you would execute the above commands as shown in the example below

list all machines

htb --list all

list owned machines

htb --list owned

start the box Ellingson

htb --start ellingson

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for HTBClient, version 0.4.0
Filename, size File type Python version Upload date Hashes
Filename, size HTBClient-0.4.0-py2.py3-none-any.whl (17.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size HTBClient-0.4.0.tar.gz (7.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page