iridium-client

Typer CLI for Iridium reachability scanning — local AST extraction with cloud SaaS analysis.

Install

pip install iridium-client

CLI commands

`iridium-client demo`

Run the embedded vulnerable micro-target demo (<10s, no API key, no network required for indexing).

iridium-client demo
# or zero-install:
uvx iridium-client demo

`iridium-client scan`

Index a repository locally and submit the payload to Iridium SaaS. No API key required for the anonymous tier (rate-limited by IP).

iridium-client scan .

# Optional: override API host or authenticate for higher quotas
export IRIDIUM_API_URL=https://api.iridium.example.com
# export IRIDIUM_API_KEY=iridium_live_...

Option	Description
`--api-url`	Override `IRIDIUM_API_URL`
`--anonymize`	HMAC-hash internal symbols in payload (requires `IRIDIUM_ANON_KEY`)
`--telemetry`	Opt in to anonymized product analytics (off by default)
`--no-telemetry`	Disable product analytics for this run
`--on-error pass`	Show local stats if API is unreachable (default: `block`)

`iridium-client payload dump`

Dump the local scan payload as JSON (zero network).

iridium-client payload dump . --validate
iridium-client payload dump . --output payload.json --validate

Option	Description
`--validate`	Validate against `ClientScanPayload` schema
`--output`, `-o`	Write JSON to file instead of stdout

Environment variables

Variable	Default	Description
`IRIDIUM_API_URL`	`https://api.iridium.example.com`	SaaS API base URL
`IRIDIUM_API_KEY`	—	Optional (`X-API-Key`). Anonymous scans work without it
`DO_NOT_TRACK`	unset	`1` always disables analytics
`IRIDIUM_TELEMETRY`	`0`	`1` opts in to anonymized analytics
`IRIDIUM_ANON_KEY`	—	Key for `--anonymize` mode

Copy packages/iridium-client/.env.example to .env for local development.

Development

Part of the Iridium monorepo. From repo root:

uv sync
uv run iridium-client demo
uv run pytest packages/iridium-client/tests -v

Metadata

Release files for iridium-client 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for iridium-client 0.5.0
File	Size	Uploaded
iridium_client-0.5.0.tar.gz	8.5 kB	Aug 30, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for iridium-client 0.5.0
File	Interpreter	ABI	Platform	Reset
iridium_client-0.5.0-py3-none-any.whl 8.5 kB Aug 30, 2026	Python 3	none	any	Details

Total release size: 17.1 kB

Release files / iridium_client-0.5.0.tar.gz

Download URL	iridium_client-0.5.0.tar.gz
Size	8.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`a0628d1355d46514988da91ebdc0160c37161d6e950cab5c4758326bc9faf019`
BLAKE2b-256 checksum How to use checksums	`e15ca1d4b9e0a3cf849d19d82d1dbdf63ee041ef54dce16f3bc6a93fdfb90ccf`
Upload date	Aug 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/mziqudhd92/Iridium
Publishing commit: github.com/mziqudhd92/Iridium/tree/caf6e9355bdb71f64397b03613bf15a6e6f44480

Workflow

Publishing configuration: github.com/mziqudhd92/Iridium/blob/caf6e9355bdb71f64397b03613bf15a6e6f44480/.github/workflows/publish-client.yml
Publishing logs: github.com/mziqudhd92/Iridium/actions/runs/33303755488/attempts/1

Artifact

Subject: iridium_client-0.5.0.tar.gz
SHA-256 checksum: a0628d1355d46514988da91ebdc0160c37161d6e950cab5c4758326bc9faf019 Verifying attestations

Release files / iridium_client-0.5.0-py3-none-any.whl

Download URL	iridium_client-0.5.0-py3-none-any.whl
Size	8.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`267163619b126581ba989ffb8c78025433bace5b8794d6d8cc7a6552c7874f1d`
BLAKE2b-256 checksum How to use checksums	`9290b20c1f29745d4461b39d77df502cb78ead822acee50f51527b07e13e43bc`
Upload date	Aug 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/mziqudhd92/Iridium
Publishing commit: github.com/mziqudhd92/Iridium/tree/caf6e9355bdb71f64397b03613bf15a6e6f44480

Workflow

Publishing configuration: github.com/mziqudhd92/Iridium/blob/caf6e9355bdb71f64397b03613bf15a6e6f44480/.github/workflows/publish-client.yml
Publishing logs: github.com/mziqudhd92/Iridium/actions/runs/33303755488/attempts/1

Artifact

Subject: iridium_client-0.5.0-py3-none-any.whl
SHA-256 checksum: 267163619b126581ba989ffb8c78025433bace5b8794d6d8cc7a6552c7874f1d Verifying attestations