Merge pull request #91 from lap1nou/exh-docs

docs: added exegol-history documentation

Author: ShutdownRepo

docs/.vitepress/config.mts

@@ -280,6 +280,10 @@ function sidebarMain(): SidebarItemWithBadge[] {
           text: "My resources",
           link: "images/my-resources.md"
         },
+        {
+          text: "Exegol history",
+          link: "images/exegol-history.md"
+        },
         {
           text: "Credentials",
           link: "images/credentials.md"

docs/src/images/exegol-history.md

@@ -0,0 +1,48 @@
+# Exegol-history
+
+`Exegol-history` is a tool to quickly store and retrieve compromised credentials and hosts; the goal is to ease the management of credentials and hosts during a penetration testing engagement or a CTF.
+
+Once an asset is selected from the TUI, the information can be accessed through environment variables and doesn't need to be typed over and over. Combined with Exegol's pre-filled command history, this becomes a very powerful process.
+
+The tool can be used with the alias `exh` or with `exegol-history`.
+
+> [!TIP] TL; DR
+> When obtaining new credentials, the process usually goes like this
+> ```bash
+> exh add creds -u 'USER' -p 'PASSWORD' -H 'NT_HASH_if_any' -d 'DOMAIN.FQDN'
+> ```
+> and then, once they're saved in exh's db, set them for the current shell with
+> ```bash
+> exh set creds
+> ```
+
+## Examples
+
+Interactively select a credential to set in the current shell
+```sh
+exh set creds
+```
+
+Show the current shell's environnment variables (in the context of Exegol history)
+```sh
+exh show
+```
+
+Add a credential
+```sh
+exh add creds -u 'Administrator' -p 'Passw0rd!' -H 'FC525C9683E8FE067095BA2DDC971889' -d 'test.local'
+```
+
+Add a host
+```sh
+exh add hosts --ip '127.0.0.1' -n 'dc.test.local' -r 'DC'
+```
+
+Import multiple credentials from a CSV file
+```sh
+exh import creds --file creds.csv --format CSV
+```
+
+## Advanced variables
+
+If you have other custom variables to configure, you can manually update the file `/opt/tools/Exegol-history/profile.sh` and reload your current shell with the commnad `exec $SHELL`.

docs/src/tips-and-tricks.md

@@ -64,9 +64,7 @@ In order to **shares notes** during an engagement, `trilium`
 ## Dynamic history commands
 
 Many commands in the pre-filled history rely on environment variables
-such as `$DOMAIN`, `$USER`, `$PASSWORD`, etc. Those variables can be set
-manually or by using the `profile.sh` file in
-`/opt/tools/Exegol-history/`. The proper lines can be filled and
+such as `$DOMAIN`, `$USER`, `$PASSWORD`, etc. Those variables can be set using the [Exegol-history](images/exegol-history) utility `exh`, or by manually using the `/opt/tools/Exegol-history/profile.sh` file. The proper lines can be filled and
 uncommented, and then the shell can be reloaded with `exec zsh` in order
 to apply the changes. This allows users to easily look for, and use,
 commands in the history, without changing the values every time.