Metadata-Version: 2.4
Name: jedha-cli
Version: 3.7.0
Summary: A CLI to start cybersecurity labs and practice your skills
License-File: LICENSE
Author: ademenet
Author-email: alain@jedha.co
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.14
Requires-Dist: click (==8.1.8)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: setuptools
Requires-Dist: typer[all] (>=0.9.0,<0.10.0)
Description-Content-Type: text/markdown

# Jedha CLI

Practice your Cybersecurity skills with Jedha CLI and launch our labs directly from your terminal.

## Requirements

- Python 3.10+
- Docker
- Docker Compose
- AMD64 CPU (preferably, otherwise some labs may not work)

**This CLI is build to be used on [Kali Linux](https://www.kali.org/) priorly** and AMD64 architecture (though most of the labs will work on arm64).

It may work on other Linux distributions, but we don't support them. Also it may work on Windows and macOS but we don't support them either (but most of labs have been tested on macOS and work well).

## Installation

Be sure you meet all the requirements before installing the CLI. Then use [`pipx`](https://github.com/pypa/pipx):

```bash
pipx install jedha-cli
pipx ensurepath
```

You are good to go!

## Usage

Check the help command to see the available commands:

```bash
$ jedha-cli --help
 Usage: jedha-cli [OPTIONS] COMMAND [ARGS]...

 A CLI to manage the labs for Cybersecurity Bootcamp at Jedha (https://jedha.co).
 ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀===========⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
 ⠀⠀⠀⠀⠀⠀⠀⠀==================⠀⠀⠀⠀⠀⠀⠀⠀
 ⠀⠀⠀⠀⠀⠀=======⠀⠀⠀⠀⠀⠀⠀⠀=======⠀⠀⠀⠀⠀⠀
 ⠀⠀⠀⠀⠀+++==⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀====⠀⠀⠀⠀⠀
 ⠀⠀⠀⠀***+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀====⠀⠀==
 ⠀⠀⠀⠀***⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀=====⠀⠀
 ⠀⠀⠀****⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀===========⠀⠀⠀
 ⠀⠀⠀****⠀⠀⠀⠀⠀⠀⠀++======⠀⠀⠀⠀⠀====⠀⠀⠀
 ⠀⠀⠀⠀⠀⠀⠀********+++⠀⠀⠀⠀⠀⠀⠀⠀⠀====⠀⠀⠀
 **************⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀====⠀⠀⠀⠀
 ⠀⠀⠀⠀⠀*****⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀====⠀⠀⠀⠀⠀
 ⠀⠀⠀⠀⠀⠀*******⠀⠀⠀⠀⠀⠀⠀⠀+++====⠀⠀⠀⠀⠀⠀
 ⠀⠀⠀⠀⠀⠀⠀⠀**************++++⠀⠀⠀⠀⠀⠀⠀⠀
 ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀***********⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀

╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --version          Show the jedha-cli version and exit.                                                                   │
│ --help             Show this message and exit.                                                                            │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ dl          Download (but not start) a lab: useful if it's been updated.                                                  │
│ list        List all the labs available.                                                                                  │
│ remove      Remove definitively a specific lab environment: useful to free some disk space.                               │
│ restart     Restart a lab.                                                                                                │
│ start       Start a specific lab environment.                                                                             │
│ status      Show the running lab. If a lab name is provided, it will show the status of that lab.                         │
│ stop        Stop a specific lab environment.                                                                              │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

 Made with ❤️ by the Jedha Bootcamp Team
```

