Skip to content

Commit

Permalink
Add missing pages
Browse files Browse the repository at this point in the history
  • Loading branch information
qu35t-code committed Jan 8, 2024
1 parent b80911b commit 95b0531
Show file tree
Hide file tree
Showing 10 changed files with 71 additions and 0 deletions.
Binary file added docs/assets/commands/update/update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/commands/version/version.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/commands/vpn/download.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/commands/vpn/list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/commands/vpn/start.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/commands/vpn/stop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions docs/commands/update.md
Original file line number Diff line number Diff line change
@@ -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)
9 changes: 9 additions & 0 deletions docs/commands/version.md
Original file line number Diff line number Diff line change
@@ -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)
51 changes: 51 additions & 0 deletions docs/commands/vpn.md
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 95b0531

Please sign in to comment.