@starkscan/cli
v0.0.2
Published
Agent-ready Starkscan CLI for beta workflows. Stable latest is fail-closed; use @starkscan/cli@alpha.
Maintainers
Readme
@starkscan/cli
Agent-ready Starkscan CLI for terminal and automation workflows.
The npm
latestchannel is intentionally fail-closed until the stable CLI is released. Run@starkscan/cli@alpha, or pin an exact alpha version for unattended agents and production services.
Run
| Use case | Command |
| --- | --- |
| Check your local setup | npx -y @starkscan/cli@alpha doctor |
| Query Starknet status | npx -y @starkscan/cli@alpha status |
| Pin the smoked beta | npx -y @starkscan/[email protected] doctor |
| Stable channel | npx @starkscan/cli currently exits with upgrade guidance |
Environment
export STARKSCAN_BASE_URL="https://starkscan.co/api"
export STARKSCAN_API_KEY="<store this in your shell or agent secret store>"
export STARKSCAN_CHAIN="SN_MAIN"What this package is for
- Run Starkscan API checks and data queries from scripts, CI, and local shells.
- Give agents a stable command surface for status checks and future route smokes.
- Install prebuilt native CLI artifacts from npm without cloning the private repo.
Trust model
latestfails closed by design until stable GA.alphais the beta channel; use exact pins for unattended jobs.- The alpha package verifies bundled native artifact manifests and checksums before execution.
- Package trust, release policy, and Socket/OpenSSF signals are documented at https://starkscan.co/docs/build/package-trust.
Links
- CLI docs: https://starkscan.co/docs/ai/agent-cli
- API key setup: https://starkscan.co/api-key
- Package trust: https://starkscan.co/docs/build/package-trust
- npm versions: https://www.npmjs.com/package/@starkscan/cli?activeTab=versions
