Skip to content

Commit

Permalink
Clean documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
QU35T-code committed Jan 8, 2024
1 parent 95b0531 commit 0357cc4
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 3 deletions.
Binary file added docs/assets/commands/globals/batch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions docs/commands/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Introduction

This section describes each command available via **htb-cli**. In addition, this page explains the functionality of the **global flags** for each command.

## Batch (--batch)

This flag allows you to answer **"yes"** to any question that may be asked by htb-cli.

```bash
htb-cli info -c OOPArtDB --batch
```

![Batch](/assets/commands/globals/batch.png)

## No Check (--no-check)

By default, with each command, a request is sent to **Github** to check if the tool is **up to date** or if a **new version is available**.

The `--no-check` flag allows you not to check if a new update is available.

## Proxy (--proxy)

The `--proxy` flag is used to route all htb-cli **traffic to a proxy** (e.g. BurpSuite).

```bash
htb-cli info --proxy http://127.0.0.1:8080
```

## Verbose (-v)

The **verbose flag** displays more information during program execution.
It has 2 levels:

* Level 1 displays **additional information**.
* Level 2 displays **debug information**.
8 changes: 5 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,18 @@ nav:
- Installation: installation.md
- Configuration: configuration.md
- Commands:
- Introduction: commands/introduction.md
- Version: commands/version.md
- Update: commands/update.md
- Shoutbox: commands/shoutbox.md
- Sherlocks: commands/sherlocks.md
- Info: commands/info.md
- Machines: commands/machines.md
- Start: commands/start.md
- Stop: commands/stop.md
- Reset: commands/reset.md
- Status: commands/status.md
- Submit: commands/submit.md
- VPN: commands/vpn.md
- Version: commands/version.md
- Update: commands/update.md
- Status: commands/status.md


0 comments on commit 0357cc4

Please sign in to comment.