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.4.0.tar.gz (230.4 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.4.0-py3-none-any.whl (245.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for adscan-6.4.0.tar.gz
Algorithm Hash digest
SHA256 48d79c3c8d270e60ae44f16723c1fd2927dfe605860ea90e665fd37712d92420
MD5 402c184a36aaccb9f49b175973c019b8
BLAKE2b-256 d1e5c4ea49a6cb89577838cbbdef384c146be5bf6da86c1f64a4f4fd98d07c08

See more details on using hashes here.

File details

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

File metadata

  • Download URL: adscan-6.4.0-py3-none-any.whl
  • Upload date:
  • Size: 245.2 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e229350d21a79bf9b731ab83d1638bcb4853610ec98fd54a0b4224bdaf9fdfd5
MD5 25bd0b7ed62a363f76649becb28d03f8
BLAKE2b-256 5d39ad631d4ca4a60a2d3e9333a7ae2593f6cdf01eaaa28cca623a555d286af4

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