@starkscan/cli 0.0.0 → 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 (4) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +38 -3
  3. package/bin/starkscan.js +4 -3
  4. package/package.json +32 -7
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Starkscan contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,10 +1,45 @@
1
1
  # @starkscan/cli
2
2
 
3
- The stable Starkscan CLI channel is not released yet.
3
+ Agent-ready Starkscan CLI for terminal and automation workflows.
4
4
 
5
- Use the beta explicitly:
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
+
9
+ ## Run
10
+
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 |
17
+
18
+ ## Environment
6
19
 
7
20
  ```bash
8
- npx -y @starkscan/cli@alpha
21
+ export STARKSCAN_BASE_URL="https://starkscan.co/api"
22
+ export STARKSCAN_API_KEY="<store this in your shell or agent secret store>"
23
+ export STARKSCAN_CHAIN="SN_MAIN"
9
24
  ```
10
25
 
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
41
+
42
+ - CLI docs: <https://starkscan.co/docs/ai/agent-cli>
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/bin/starkscan.js CHANGED
@@ -1,5 +1,6 @@
1
1
  #!/usr/bin/env node
2
- console.error("The stable @starkscan/cli channel is not released yet.");
3
- console.error("Use the beta explicitly: npx -y @starkscan/cli@alpha");
4
- process.exit(1);
5
2
 
3
+ console.error(
4
+ "@starkscan/cli stable channel is not released yet. Use npx -y @starkscan/cli@alpha or pin an exact 0.1.0-alpha.x version.",
5
+ );
6
+ process.exit(1);
package/package.json CHANGED
@@ -1,16 +1,41 @@
1
1
  {
2
2
  "name": "@starkscan/cli",
3
- "version": "0.0.0",
4
- "description": "Stable placeholder for the Starkscan CLI. Use @starkscan/cli@alpha for the current beta.",
3
+ "private": false,
4
+ "version": "0.0.2",
5
+ "description": "Agent-ready Starkscan CLI for beta workflows. Stable latest is fail-closed; use @starkscan/cli@alpha.",
6
+ "license": "MIT",
5
7
  "type": "module",
6
- "bin": {
7
- "starkscan": "./bin/starkscan.js"
8
+ "publishConfig": {
9
+ "access": "public"
10
+ },
11
+ "homepage": "https://starkscan.co/docs/ai/agent-cli",
12
+ "bugs": {
13
+ "url": "https://starkscan.co/docs/build/package-trust"
14
+ },
15
+ "repository": {
16
+ "type": "git",
17
+ "url": "https://github.com/starknet-innovation/mezcal",
18
+ "directory": "webapp/packages/stable-placeholders/cli"
8
19
  },
20
+ "keywords": [
21
+ "starkscan",
22
+ "starknet",
23
+ "block-explorer",
24
+ "cairo",
25
+ "web3",
26
+ "cli",
27
+ "agent",
28
+ "npx"
29
+ ],
9
30
  "files": [
31
+ "bin",
10
32
  "README.md",
11
- "bin"
33
+ "LICENSE"
12
34
  ],
13
- "publishConfig": {
14
- "access": "public"
35
+ "bin": {
36
+ "starkscan": "./bin/starkscan.js"
37
+ },
38
+ "engines": {
39
+ "node": ">=18"
15
40
  }
16
41
  }