@starkscan/cli 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +29 -20
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,25 +1,19 @@
1
1
  # @starkscan/cli
2
2
 
3
- Stable channel placeholder for the Starkscan CLI.
3
+ Agent-ready Starkscan CLI for terminal and automation workflows.
4
4
 
5
- The production `latest` channel is not released yet. This package exists so
6
- `npm install -g @starkscan/cli` and `npx @starkscan/cli` fail closed instead of
7
- running a moving alpha.
5
+ > The npm `latest` channel is intentionally fail-closed until the stable CLI is
6
+ > released. Run `@starkscan/cli@alpha`, or pin an exact alpha version for
7
+ > unattended agents and production services.
8
8
 
9
- ## Current beta
9
+ ## Run
10
10
 
11
- Run the alpha channel explicitly:
12
-
13
- ```bash
14
- npx -y @starkscan/cli@alpha doctor
15
- npx -y @starkscan/cli@alpha status
16
- ```
17
-
18
- For unattended agents or production services, pin an exact smoked version:
19
-
20
- ```bash
21
- npx -y @starkscan/cli@0.1.0-alpha.2 doctor
22
- ```
11
+ | Use case | Command |
12
+ | --- | --- |
13
+ | Check your local setup | `npx -y @starkscan/cli@alpha doctor` |
14
+ | Query Starknet status | `npx -y @starkscan/cli@alpha status` |
15
+ | Pin the smoked beta | `npx -y @starkscan/cli@0.1.0-alpha.2 doctor` |
16
+ | Stable channel | `npx @starkscan/cli` currently exits with upgrade guidance |
23
17
 
24
18
  ## Environment
25
19
 
@@ -29,8 +23,23 @@ export STARKSCAN_API_KEY="<store this in your shell or agent secret store>"
29
23
  export STARKSCAN_CHAIN="SN_MAIN"
30
24
  ```
31
25
 
32
- ## Trust links
26
+ ## What this package is for
27
+
28
+ - Run Starkscan API checks and data queries from scripts, CI, and local shells.
29
+ - Give agents a stable command surface for status checks and future route smokes.
30
+ - Install prebuilt native CLI artifacts from npm without cloning the private repo.
31
+
32
+ ## Trust model
33
+
34
+ - `latest` fails closed by design until stable GA.
35
+ - `alpha` is the beta channel; use exact pins for unattended jobs.
36
+ - The alpha package verifies bundled native artifact manifests and checksums before execution.
37
+ - Package trust, release policy, and Socket/OpenSSF signals are documented at
38
+ <https://starkscan.co/docs/build/package-trust>.
39
+
40
+ ## Links
33
41
 
34
- - Package trust: <https://starkscan.co/docs/build/package-trust>
35
42
  - CLI docs: <https://starkscan.co/docs/ai/agent-cli>
36
- - npm alpha: <https://www.npmjs.com/package/@starkscan/cli?activeTab=versions>
43
+ - API key setup: <https://starkscan.co/api-key>
44
+ - Package trust: <https://starkscan.co/docs/build/package-trust>
45
+ - npm versions: <https://www.npmjs.com/package/@starkscan/cli?activeTab=versions>
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@starkscan/cli",
3
3
  "private": false,
4
- "version": "0.0.1",
5
- "description": "Stable placeholder for the Starkscan CLI. Use @starkscan/cli@alpha for the current beta.",
4
+ "version": "0.0.2",
5
+ "description": "Agent-ready Starkscan CLI for beta workflows. Stable latest is fail-closed; use @starkscan/cli@alpha.",
6
6
  "license": "MIT",
7
7
  "type": "module",
8
8
  "publishConfig": {