diff --git a/docs/assets/commands/update/update.png b/docs/assets/commands/update/update.png new file mode 100644 index 0000000..f80f398 Binary files /dev/null and b/docs/assets/commands/update/update.png differ diff --git a/docs/assets/commands/version/version.png b/docs/assets/commands/version/version.png new file mode 100644 index 0000000..bc853a6 Binary files /dev/null and b/docs/assets/commands/version/version.png differ diff --git a/docs/assets/commands/vpn/download.png b/docs/assets/commands/vpn/download.png new file mode 100644 index 0000000..12d7b41 Binary files /dev/null and b/docs/assets/commands/vpn/download.png differ diff --git a/docs/assets/commands/vpn/list.png b/docs/assets/commands/vpn/list.png new file mode 100644 index 0000000..6d9d9bf Binary files /dev/null and b/docs/assets/commands/vpn/list.png differ diff --git a/docs/assets/commands/vpn/start.png b/docs/assets/commands/vpn/start.png new file mode 100644 index 0000000..e5fed12 Binary files /dev/null and b/docs/assets/commands/vpn/start.png differ diff --git a/docs/assets/commands/vpn/stop.png b/docs/assets/commands/vpn/stop.png new file mode 100644 index 0000000..9eb150c Binary files /dev/null and b/docs/assets/commands/vpn/stop.png differ diff --git a/docs/commands/update.md b/docs/commands/update.md new file mode 100644 index 0000000..f6bcb6a --- /dev/null +++ b/docs/commands/update.md @@ -0,0 +1,9 @@ +# Update + +The **update** command is used to check whether a new htb-cli update is available. No options are required. + +```bash +htb-cli update +``` + +![Update](/assets/commands/update/update.png) \ No newline at end of file diff --git a/docs/commands/version.md b/docs/commands/version.md new file mode 100644 index 0000000..691d7f6 --- /dev/null +++ b/docs/commands/version.md @@ -0,0 +1,9 @@ +# Version + +The version used by **htb-cli** can be retrieved via the **version command**. No options are required. + +```bash +htb-cli version +``` + +![Version](/assets/commands/version/version.png) \ No newline at end of file diff --git a/docs/commands/vpn.md b/docs/commands/vpn.md index 4bbc3e1..84aaa0a 100644 --- a/docs/commands/vpn.md +++ b/docs/commands/vpn.md @@ -1,2 +1,53 @@ # VPN +The **vpn** command lets you manage VPNs to connect to HackTheBox machines. + +## Download VPNs + +The `-d` or `--download` flag **downloads all VPNs** assigned to the user. +The **VPN configuration files** will be downloaded to the following folder: `~/.local/htb-cli/` + +```bash +htb-cli vpn --download +``` + +![Download](/assets/commands/vpn/download.png) + +## List assigned VPNs + +The VPNs assigned can be listed with the `--list` flag. + +```bash +htb-cli vpn --list +``` + +![List](/assets/commands/vpn/list.png) + + +## Starting a VPN + +A VPN can be started with the `--start` flag. +The **mode** must be specified with the `-m` flag from the following list: + +* labs +* sp +* fortresses +* prolabs +* endgames +* competitive + +```bash +htb-cli vpn -m labs --start +``` + +![Start](/assets/commands/vpn/start.png) + +## Stop the VPN + +We can also stop the active VPN with the `--stop` flag. + +```bash +htb-cli vpn --stop +``` + +![Stop](/assets/commands/vpn/stop.png) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 092dcdc..bf1174e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -58,4 +58,6 @@ nav: - Status: commands/status.md - Submit: commands/submit.md - VPN: commands/vpn.md + - Version: commands/version.md + - Update: commands/update.md \ No newline at end of file