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.
export IRIDIUM_API_URL=https://api.iridium.example.com
export IRIDIUM_API_KEY=iridium_live_...
iridium-client scan .
| Option | Description |
|---|---|
--api-url |
Override IRIDIUM_API_URL |
--anonymize |
HMAC-hash internal symbols in payload (requires IRIDIUM_ANON_KEY) |
--no-telemetry |
Disable product analytics pings |
--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 |
— | API key (X-API-Key header) |
DO_NOT_TRACK |
unset | 1 disables analytics |
IRIDIUM_TELEMETRY |
1 |
0 disables 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
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file iridium_client-0.1.0.tar.gz.
File metadata
- Download URL: iridium_client-0.1.0.tar.gz
- Upload date:
- Size: 7.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
736c8577d9db901cdb098ce6fc2d4937c2fc5d0fddda1a2e61bb0eec8d498109
|
|
| MD5 |
4ac5cf17daf11df3a53796808fc97848
|
|
| BLAKE2b-256 |
2f197953715f5252206a00322eb4c24ab307f90f6980abc98fe6f7dffd7435cb
|
Provenance
The following attestation bundles were made for iridium_client-0.1.0.tar.gz:
Publisher:
publish-client.yml on mziqudhd92/Iridium
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
iridium_client-0.1.0.tar.gz -
Subject digest:
736c8577d9db901cdb098ce6fc2d4937c2fc5d0fddda1a2e61bb0eec8d498109 - Sigstore transparency entry: 2609076173
- Sigstore integration time:
-
Permalink:
mziqudhd92/Iridium@c773fb231054ce91265222eeaedff9d6b45dfb30 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/mziqudhd92
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-client.yml@c773fb231054ce91265222eeaedff9d6b45dfb30 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file iridium_client-0.1.0-py3-none-any.whl.
File metadata
- Download URL: iridium_client-0.1.0-py3-none-any.whl
- Upload date:
- Size: 7.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8bfb6645bf6bc4eadd2f9799f6a4aeea1d7ad22623411e06b5e585425e358223
|
|
| MD5 |
3a069b3c37fe3d3ef23a378b1194706a
|
|
| BLAKE2b-256 |
3da66368316740b93b612a346e050863176ef4464ec8f4c68b4d70ee47caf677
|
Provenance
The following attestation bundles were made for iridium_client-0.1.0-py3-none-any.whl:
Publisher:
publish-client.yml on mziqudhd92/Iridium
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
iridium_client-0.1.0-py3-none-any.whl -
Subject digest:
8bfb6645bf6bc4eadd2f9799f6a4aeea1d7ad22623411e06b5e585425e358223 - Sigstore transparency entry: 2609076208
- Sigstore integration time:
-
Permalink:
mziqudhd92/Iridium@c773fb231054ce91265222eeaedff9d6b45dfb30 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/mziqudhd92
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-client.yml@c773fb231054ce91265222eeaedff9d6b45dfb30 -
Trigger Event:
workflow_dispatch
-
Statement type:
