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.1.0.tar.gz (213.9 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.1.0-py3-none-any.whl (228.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for adscan-6.1.0.tar.gz
Algorithm Hash digest
SHA256 37811fec388c150df68741cd11e0dc714b71a58fc04c2cd9d431fd9c99defbe0
MD5 1462c33e112fcbb3af2cc5b4a4b7adec
BLAKE2b-256 3e618e0c7f15b7ae5851d97a70be724a889d40e06a5120339ff65efe492e0e4e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: adscan-6.1.0-py3-none-any.whl
  • Upload date:
  • Size: 228.0 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b9293b8f427e4acc9dd8c7731f0be11911db0687b724f28d1a5bcb4234508fb4
MD5 e415fedb7fb3c0e1bec563c88a72f0ef
BLAKE2b-256 ada8dba0cc64d7d8ada6c0a1bf00a92735429024973e984f34b9633df1621765

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