Skip to content

Commit

Permalink
added missing dev docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TheTechromancer committed Oct 17, 2023
1 parent 0bad648 commit 4ee94ed
Show file tree
Hide file tree
Showing 5 changed files with 65 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/dev/helpers/command.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Command Helpers

These are helpers related to executing shell commands. They are used throughout BBOT and its modules for executing various binaries such as `nmap`, `nuclei`, etc.

Note that these helpers can be invoked directly from `self.helpers`, e.g.:

```python
self.helpers.run("ls", "-l")
```

::: bbot.core.helpers.command
options:
show_root_heading: false
19 changes: 19 additions & 0 deletions docs/dev/helpers/dns.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# DNS

These are helpers related to DNS resolution. They are used throughout BBOT and its modules for performing DNS lookups and detecting DNS wildcards, etc.

Note that these helpers can be invoked directly from `self.helpers`, e.g.:

```python
self.helpers.resolve("evilcorp.com")
```

::: bbot.core.helpers.dns.DNSHelper
handler: python
options:
members:
- resolve
- resolve_batch
- resolve_raw
- is_wildcard
- is_wildcard_domain
5 changes: 5 additions & 0 deletions docs/dev/helpers/interactsh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Interact.sh

::: bbot.core.helpers.interactsh.Interactsh
options:
show_root_heading: false
15 changes: 15 additions & 0 deletions docs/dev/helpers/web.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Web

These are helpers for making various web requests.

Note that these helpers can be invoked directly from `self.helpers`, e.g.:

```python
self.helpers.request("https://www.evilcorp.com")
```

::: bbot.core.helpers.web
options:
show_root_heading: false
members:
- WebHelper
13 changes: 13 additions & 0 deletions docs/dev/helpers/wordcloud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Word Cloud

These are helpers related to BBOT's Word Cloud, a mechanism for storing target-specific keywords that are useful for custom wordlists, etc.

Note that these helpers can be invoked directly from `self.helpers`, e.g.:

```python
self.helpers.word_cloud
```

::: bbot.core.helpers.wordcloud
options:
show_root_heading: false

0 comments on commit 4ee94ed

Please sign in to comment.