ADscan launcher (host-side) that orchestrates Docker to run the ADscan runtime.
Project description
ADscan (PyPI Launcher)
This PyPI package provides the adscan command as a lightweight Python launcher.
The launcher is responsible for:
- pulling the ADscan Docker image (
adscan install) - running the ADscan CLI inside Docker (
adscan start,adscan ci, and passthrough commands)
The full ADscan CLI implementation lives inside the Docker image.
Requirements
- Linux host (x86_64)
- Docker Engine + Docker Compose plugin installed
- Permission to run Docker (root or user in the
dockergroup)
Quick Start
pip install adscan
adscan install
adscan start
Local development with uv
If you cloned this repository and want to run the launcher locally:
uv sync --extra dev
uv run adscan --help
uv run adscan version
Run lint/tests/build with uv:
uv run ruff check adscan_core adscan_launcher adscan_internal
uv run pytest -m unit
uv run python -m build
Install from TestPyPI (Kali)
Use this when validating a TestPyPI release on Kali:
python -m pip install \
--index-url https://test.pypi.org/simple/ \
--extra-index-url https://pypi.org/simple \
adscan --break-system-packages
Install a specific TestPyPI version:
python -m pip install \
--index-url https://test.pypi.org/simple/ \
--extra-index-url https://pypi.org/simple \
adscan==5.0.0.devYYYYMMDDHHMMSS --break-system-packages
Configuration
Override the Docker image used by the launcher:
export ADSCAN_DOCKER_IMAGE="adscan/adscan-lite:latest"
Use the dev channel image:
export ADSCAN_DOCKER_CHANNEL=dev
User Documentation
User-facing installation, troubleshooting, and Docker/BloodHound operational guidance is maintained in the ADscan docs site:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file adscan-6.2.3.tar.gz.
File metadata
- Download URL: adscan-6.2.3.tar.gz
- Upload date:
- Size: 227.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
868cefba5ae84abc1f507102ceb0540e6724d8537c834ba64977d32a1d9017e3
|
|
| MD5 |
5865213d3303a6d6774e49854a591894
|
|
| BLAKE2b-256 |
35b240f6595bd7bbb5543c88b46d48056042ccb5c17a967d60a9cd017a947d98
|
File details
Details for the file adscan-6.2.3-py3-none-any.whl.
File metadata
- Download URL: adscan-6.2.3-py3-none-any.whl
- Upload date:
- Size: 242.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d9f6ab96114ca5625f8acbede9dc28dfdcf0c7eaff185a6e7c77c35174e82cb5
|
|
| MD5 |
66ac0b3039e8fbf7b9805a12027142bb
|
|
| BLAKE2b-256 |
3cc281e17d3a7059e9a3688e7571761b104d2e5ac8c0e3076cf8a616ed88c441
|