idlebench 1.0.1 → 1.0.3

package/README.md

@@ -2,68 +2,172 @@
 
 **The verification CLI for idle compute.**
 
-Run one command to benchmark your machine and publish a verified score to IdleBench — the trust layer for IDLE Protocol compute providers.
+Run one command on your machine. IdleBench checks your GPU, CUDA, Docker, and network — then publishes a signed trust score buyers can verify before routing workloads to your IDLE resource.
 
-## Install & run
+[![npm](https://img.shields.io/npm/v/idlebench)](https://www.npmjs.com/package/idlebench)
+
+---
+
+## Usage
 
 ```bash
 npx idlebench run
 ```
 
-No installation required. Node.js 18+ needed.
+No installation required. Node.js 18+ only.
+
+---
 
 ## Commands
 
+### `idlebench run`
+
+Main benchmark flow. Interactive — walks you through setup, runs all checks locally, calculates a score, and uploads a signed report to IdleBench.
+
+```
+? Solana wallet address (public key):  7xKXtg2CW87...gAsU
+? Resource name:                       RTX 4090 Training Node
+? Resource type:                       GPU
+? IDLE endpoint URL (optional):        https://gateway.earnidle.com/ep/...
+```
+
+After completing, the CLI prints:
+- Final score and grade
+- Public verification URL
+- Badge embed URL
+- Local report file path
+
+If the upload fails, the report is saved locally and can be uploaded later with `idlebench upload`.
+
+---
+
+### `idlebench doctor`
+
+Checks your local environment without running a benchmark or uploading anything. Use this to diagnose issues before a full run.
+
 ```bash
-npx idlebench run          # Run full benchmark and upload report
-npx idlebench doctor       # Check local environment readiness
-npx idlebench upload <path> # Upload a saved report JSON
-npx idlebench version      # Show version
+npx idlebench doctor
 ```
 
-## What it checks
+Checks: Node.js version, OS, CPU, RAM, GPU detection, NVIDIA driver, CUDA, Docker, Docker GPU runtime, network connectivity.
 
-| Check | Description |
-|-------|-------------|
-| GPU detection | Model, VRAM via nvidia-smi or systeminformation |
-| CUDA | Availability and version |
-| NVIDIA driver | Driver version |
-| Docker | Installation and daemon status |
-| Docker GPU runtime | Tests docker --gpus all |
-| CPU benchmark | Hash workload + matrix calculation |
-| Network latency | Round-trip to IdleBench API |
+---
 
-## Security
+### `idlebench upload <path>`
+
+Uploads a previously saved report JSON without re-running the benchmark.
+
+```bash
+idlebench upload ./idlebench-report-1717200000000.json
+```
+
+The report is validated before uploading. The hash is verified to ensure the file has not been modified.
 
-IdleBench **never asks for private keys or seed phrases**. Only your public wallet address is used to identify your provider profile.
+---
 
-All checks run locally. Only the structured benchmark report is uploaded.
+### `idlebench version`
 
-## Environment variables
+Prints the installed CLI version.
 
 ```bash
-IDLEBENCH_API_URL=https://idlebench.com  # Override API URL
+idlebench version
 ```
 
-## Publish to npm
+---
+
+## What gets checked
+
+| Check | Description |
+|-------|-------------|
+| System info | OS, architecture, CPU model and core count, total RAM |
+| GPU detection | Model, VRAM, vendor — via nvidia-smi, falls back to systeminformation |
+| CUDA | Availability and version from nvidia-smi |
+| NVIDIA driver | Driver version |
+| Docker | Installed version and daemon status |
+| Docker GPU runtime | Tests `docker run --rm --gpus all nvidia/cuda:12.3...` |
+| Network latency | Round-trip to IdleBench API, 3-sample average |
+| CPU benchmark | SHA-256 hash workload (2048 iterations) + 128×128 matrix multiply |
+
+---
+
+## Scoring
+
+Final score = weighted average of five components:
+
+| Component | Weight | Notes |
+|-----------|--------|-------|
+| GPU Capability | 30% | GPU model matched against a curated table. VRAM adds a bonus. |
+| Docker & CUDA | 20% | Docker +40, CUDA +25, GPU runtime +15. Starts at 20. |
+| Benchmark Performance | 20% | CPU workload timing and GPU container readiness. |
+| Network Latency | 15% | <20ms → 100, <100ms → 82, >600ms → 15. |
+| System Stability | 15% | Based on CPU cores and RAM. Starts at 75. |
+
+**Grades:**
+
+| Grade | Score |
+|-------|-------|
+| Elite | 95–100 |
+| Verified A | 85–94 |
+| Verified B | 70–84 |
+| Risky | 55–69 |
+| Not Recommended | Below 55 |
+
+---
+
+## Report format
+
+Reports are saved as `idlebench-report-[timestamp].json` in the current directory.
+
+```json
+{
+  "reportVersion": "1.0.0",
+  "providerWallet": "7xKXtg2CW87...gAsU",
+  "resourceName": "RTX 4090 Training Node",
+  "resourceType": "GPU",
+  "system": { "os": "Ubuntu 22.04", "arch": "x64", "cpuModel": "...", "cpuCores": 24, "ramGb": 64 },
+  "gpu": { "name": "NVIDIA RTX 4090", "vramGb": 24, "cudaAvailable": true, "cudaVersion": "12.3" },
+  "runtime": { "dockerAvailable": true, "dockerVersion": "24.0.7", "dockerGpuRuntime": true },
+  "network": { "latencyMs": 42, "downloadMbps": 940 },
+  "scores": { "gpuScore": 97, "runtimeScore": 100, "networkScore": 95, "inferenceScore": 92, "stabilityScore": 90, "finalScore": 94, "grade": "Verified A" },
+  "metadata": { "createdAt": "...", "cliVersion": "1.0.2" },
+  "reportHash": "sha256:..."
+}
+```
+
+---
+
+## Security
+
+- **IdleBench never asks for private keys or seed phrases.** A security notice is printed at every startup.
+- All checks run locally. Only the structured report is uploaded.
+- The report hash is SHA-256 of the report body. Buyers can verify it independently.
+
+---
+
+## Development
 
 ```bash
+git clone ...
 cd idlebench-cli
 npm install
-npm run build
-npm publish --access public
+npm run build   # compiles TypeScript → dist/
+npm link        # makes `idlebench` available globally
+
+idlebench doctor
+idlebench run
 ```
 
-## Local development
+## Publish
 
 ```bash
-npm install
 npm run build
-npm link
-idlebench doctor
-idlebench run
+npm publish --access public
 ```
 
-## License
+---
+
+## Links
 
-MIT
+- Web app: [idlebench.com](https://idlebench.com)
+- npm: [npmjs.com/package/idlebench](https://www.npmjs.com/package/idlebench)
+- IDLE Protocol: [earnidle.com](https://earnidle.com)

package/dist/commands/run.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/commands/run.ts"],"names":[],"mappings":"AA4IA,wBAAsB,mBAAmB,kBAgMxC"}
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/commands/run.ts"],"names":[],"mappings":"AA8IA,wBAAsB,mBAAmB,kBAgMxC"}

package/dist/commands/run.js

@@ -9,7 +9,9 @@ import { getNetworkInfo } from '../lib/network.js';
 import { runBenchmark } from '../lib/benchmark.js';
 import { calculateGpuScore, calculateRuntimeScore, calculateNetworkScore, calculateInferenceScore, calculateStabilityScore, calculateFinalScore, getGrade, } from '../lib/scoring.js';
 import { buildReport, saveReportLocally } from '../lib/report.js';
-const CLI_VERSION = '1.0.0';
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+const { version: CLI_VERSION } = require('../../package.json');
 const DEFAULT_API_URL = 'https://idlebench.vercel.app';
 function line() {
     console.log(chalk.dim(' ─────────────────────────────────────────'));
@@ -99,7 +101,7 @@ async function promptSetup() {
         {
             type: 'input',
             name: 'idleGatewayUrl',
-            message: 'IDLE gateway URL (optional, press Enter to skip):',
+            message: 'IDLE endpoint URL (from earnidle.com, optional — press Enter to skip):',
             default: '',
             validate: (input) => {
                 if (!input.trim())
@@ -109,7 +111,7 @@ async function promptSetup() {
                     return true;
                 }
                 catch {
-                    return 'Enter a valid URL or leave blank';
+                    return 'Enter a valid URL (e.g. https://gateway.earnidle.com/ep/...) or leave blank';
                 }
             },
         },

package/dist/index.js

@@ -1,10 +1,12 @@
 #!/usr/bin/env node
 import { Command } from 'commander';
 import chalk from 'chalk';
+import { createRequire } from 'module';
 import { runBenchmarkCommand } from './commands/run.js';
 import { runDoctor } from './commands/doctor.js';
 import { runUpload } from './commands/upload.js';
-const VERSION = '1.0.0';
+const require = createRequire(import.meta.url);
+const { version: VERSION } = require('../package.json');
 const program = new Command();
 program
     .name('idlebench')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "idlebench",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Benchmark and verify idle compute before it earns. The CLI for IDLE compute providers.",
   "license": "MIT",
   "author": "IdleBench",
@@ -21,7 +21,8 @@
   "files": [
     "dist",
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "package.json"
   ],
   "scripts": {
     "build": "tsc",