Skip to main content

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 docker group)

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adscan-6.5.0.tar.gz (232.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adscan-6.5.0-py3-none-any.whl (247.5 kB view details)

Uploaded Python 3

File details

Details for the file adscan-6.5.0.tar.gz.

File metadata

  • Download URL: adscan-6.5.0.tar.gz
  • Upload date:
  • Size: 232.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for adscan-6.5.0.tar.gz
Algorithm Hash digest
SHA256 33543b1366cbf164e10de8d46e15d8d90f923b6996198ed0383a3ae7d5b2c659
MD5 944a2a94fdb7dde4a666961c4a5fe84a
BLAKE2b-256 2ccabe01582f08c95ee2cb3ac03f13dc54a8094324014f1e6445c1bbac684097

See more details on using hashes here.

File details

Details for the file adscan-6.5.0-py3-none-any.whl.

File metadata

  • Download URL: adscan-6.5.0-py3-none-any.whl
  • Upload date:
  • Size: 247.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.13

File hashes

Hashes for adscan-6.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f2339f96d89187f33c126ed7f405a09c26b9fb36926bcfa72e6a76cc53552f39
MD5 777804c5e4d7e92bc6aff0ac52a48569
BLAKE2b-256 e090a01945b93201807b52bc755b74003513a0c7abefdb544318bac66aa7e12d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page