Metadata-Version: 2.4
Name: bdsh
Version: 0.2.1
Summary: BadOS Dynamic Shell
Author-email: Logan Dhillon <dev@logandhillon.com>
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# BadOS Dynamic Shell (bdsh)

Read the docs at 🔗 [badtechnologies.github.io/bdsh](https://badtechnologies.github.io/bdsh).

## Quick Install

Run the following command:

```sh
curl -O https://raw.githubusercontent.com/badtechnologies/bdsh/main/install.py
python3 install.py
```

After completing setup, bdsh should be good to go!


## Installation (Manual)

1. **Download the latest release**

    Or, you can directly download `install.py` from the [repo](https://github.com/badtechnologies/bdsh).

> [!TIP]
> The only file needed to create a bdsh installation is `install.py`.<br>
> Running `install.py` generates, downloads, or installs everything else.

2. **Setup bdsh:**

    ```sh
    python3 install.py
    ```

    Follow the on-screen instructions.

    Once the `/bdsh` directory and your configs are prepared, you can start bdsh with `bdsh` to launch the interactive shell.

3. **Launch bdsh:**

    ```sh
    bdsh
    ```

> [!NOTE]
> This may change depending on how you created your launcher scripts.
