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.3.0.tar.gz (228.2 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.3.0-py3-none-any.whl (242.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for adscan-6.3.0.tar.gz
Algorithm Hash digest
SHA256 bad34f5a526693f066b009e9d4da937c66ca03c770d600383f9dff7ac0c0cfe5
MD5 ce746a8383fd21ce2933323442278206
BLAKE2b-256 a8bbcee06fe52f2006f3ac9dbb6f04243deddecaca9cb049123700206caa51b0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: adscan-6.3.0-py3-none-any.whl
  • Upload date:
  • Size: 242.8 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0f8307d63c819da18b337a3732c15cfe34f634c59a3e227ebb4b00be20f48f22
MD5 778d81d1a126405efbec6ccbe4aa265e
BLAKE2b-256 9716a344c13924efb8d3816b409a8f2dd892cd947384c3b5b9d319f82d1aca7d

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