Metadata-Version: 2.4
Name: bdsh
Version: 0.7.2
Summary: BadOS Dynamic Shell
Author-email: Logan Dhillon <dev@logandhillon.com>
License: Copyright (C) Bad Technologies. All rights reserved.
        
        The Bad Technologies name and branding is used under license from Logan Dhillon, and is solely the property of Logan Dhillon.
        
        No part of this software may be reproduced, distributed, modified, or used without prior written permission from the copyright holder.
Project-URL: Homepage, https://badtechnologies.github.io/bdsh
Project-URL: Documentation, https://badtechnologies.github.io/bdsh
Project-URL: Repository, https://github.com/badtechnologies/bdsh
Project-URL: Issues, https://github.com/badtechnologies/bdsh/issues
Keywords: shell,terminal,cli,command-line,BadOS,operating-system
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: System :: Shells
Classifier: Topic :: Terminals
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: argon2-cffi>=23.1.0
Requires-Dist: icmplib>=3.0.4
Requires-Dist: psutil>=5.9.0
Requires-Dist: requests>=2.31.0
Provides-Extra: test
Requires-Dist: pytest>=8.0; extra == "test"
Dynamic: license-file

# BadOS Dynamic Shell (bdsh)

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

## Quick Install

Run the following command:

```sh
python3 -m pip install bdsh
python3 -m bdsh.install
```

The installer creates the shell root, config directory, and first user.

## Installation (Manual)

1. Download the latest release.

   Or, install the package from PyPI.

2. Set up bdsh:

   ```sh
   python3 -m bdsh.install
   ```

   Follow the prompts. The setup script creates the `bdsh/` directory tree and config files.

3. Start bdsh:

   ```sh
   bdsh
   ```

Before logging in, start the BadLogon service in one terminal:

```sh
boss badlogon.sys
```

Then run `bdsh` in another terminal. The shell prompts for a username and
password, then starts an interactive session.

## Minimal boot profile

For a minimal boot prompt that does not start services or request a BadLogon
login, run:

```sh
bdsh-init
```

The same entry point is available as `python3 -m bdsh.init`. It starts a
minimal session as the `default` user in `bdsh/prf/default`, relative to the
process's working directory. It does not start services or prompt for login.
