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.6.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.6.0
File	Size	Uploaded
iridium_client-0.6.0.tar.gz	8.7 kB	Sep 13, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for iridium-client 0.6.0
File	Interpreter	ABI	Platform	Reset
iridium_client-0.6.0-py3-none-any.whl 8.8 kB Sep 13, 2026	Python 3	none	any	Details

Total release size: 17.5 kB

Release files / iridium_client-0.6.0.tar.gz

Download URL	iridium_client-0.6.0.tar.gz
Size	8.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`55a4e0137634bd14829a18ed28dacbf5231f356bb8077cfcbfdbb7c96071fe92`
BLAKE2b-256 checksum How to use checksums	`e864cf915eabd8acc41ca70be1d208379bd96d140fe17026b8c7993975f9cf01`
Upload date	Sep 13, 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/686497ea25c25c01e300861b594faacb7eaabd6e

Workflow

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

Artifact

Subject: iridium_client-0.6.0.tar.gz
SHA-256 checksum: 55a4e0137634bd14829a18ed28dacbf5231f356bb8077cfcbfdbb7c96071fe92 Verifying attestations

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

Download URL	iridium_client-0.6.0-py3-none-any.whl
Size	8.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`7850abb0a11f24e622af3c8a901d7f2cbaf62a24cb6bc39f111f2c04c74859e9`
BLAKE2b-256 checksum How to use checksums	`64f310377ccde81f764d6d705f0213303b977373e5aa19873a8b5b25cfb2f70a`
Upload date	Sep 13, 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/686497ea25c25c01e300861b594faacb7eaabd6e

Workflow

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

Artifact

Subject: iridium_client-0.6.0-py3-none-any.whl
SHA-256 checksum: 7850abb0a11f24e622af3c8a901d7f2cbaf62a24cb6bc39f111f2c04c74859e9 Verifying attestations