badgr-cli 1.0.0 → 1.0.2

package/README.md

@@ -1,6 +1,6 @@
 # badgr-cli
 
-Run or serve GPU workloads from one command.
+Badgr supports many GPU workloads through two commands: `serve` for persistent endpoints, `run` for jobs.
 
 ```bash
 npm install -g badgr-cli
@@ -18,9 +18,9 @@ badgr login
 badgr serve meta-llama/Llama-3.1-8B-Instruct --gpu L40S
 
 # 3. Use the endpoint with any OpenAI SDK client
-#    client = OpenAI(api_key="sk-...", base_url="https://dep-xyz.api.badgr.ai/v1")
+#    client = OpenAI(api_key="sk-...", base_url="https://dep-a1b2c3.api.badgr.ai/v1")
 
-# 4. View cost, provider, and route receipts
+# 4. View cost, route, and retry receipts
 badgr receipts
 
 # 5. Stop billing
@@ -34,11 +34,15 @@ badgr down <deployment-id>
 | Command | What it does |
 |---------|-------------|
 | `badgr login` | Save API key to `~/.badgr/config.json` |
-| `badgr serve <model>` | Persistent OpenAI-compatible endpoint |
-| `badgr run <command>` | One-off GPU job (container) |
-| `badgr down <id>` | Terminate a deployment — stops billing |
-| `badgr logs <id>` | Tail logs for a deployment |
-| `badgr receipts [n]` | Cost / route / retry receipts (default 10) |
+| `badgr serve <model>` | Start a persistent OpenAI-compatible endpoint |
+| `badgr run <command>` | Run a one-off GPU job (any container command) |
+| `badgr down <id>` | Terminate a deployment — stops billing immediately |
+| `badgr logs <id>` | Fetch log output from a deployment |
+| `badgr receipts [n]` | Cost, route, and retry receipts (default 10) |
+
+`badgr serve` — for anything that needs a persistent endpoint: LLM serving, embeddings, image generation APIs, transcription APIs.
+
+`badgr run` — for anything that starts, runs, and exits: batch inference, fine-tuning, evals, image/video batch jobs, audio processing.
 
 ---
 
@@ -51,7 +55,7 @@ badgr serve meta-llama/Llama-3.1-8B-Instruct --gpu L40S --region EU
 | Flag | Default | Description |
 |------|---------|-------------|
 | `--gpu <type>` | RTX_4090 | GPU: RTX_4090, L40S, A6000, A100, H100 |
-| `--region US\|EU\|AU` | US | Region preference |
+| `--region <region>` | — | Optional region preference. If omitted, Badgr chooses best available capacity. |
 | `--count <n>` | 1 | Number of GPUs (1–8) |
 | `--max-price <$/hr>` | — | Hard spend cap per GPU-hour |
 | `--dry-run` | — | Preview routing without provisioning |
@@ -69,7 +73,7 @@ badgr run python train.py --gpu A100 --env HF_TOKEN=$HF_TOKEN
 | `--gpu <type>` | RTX_4090 | GPU type |
 | `--image <img>` | python:3.11-slim | Docker image |
 | `--env KEY=VALUE` | — | Environment variable (repeatable) |
-| `--region US\|EU\|AU` | US | Region preference |
+| `--region <region>` | — | Optional region preference. If omitted, Badgr chooses best available capacity. |
 | `--max-price <$/hr>` | — | Hard spend cap per GPU-hour |
 | `--detach` | — | Launch and return immediately |
 
@@ -77,9 +81,11 @@ badgr run python train.py --gpu A100 --env HF_TOKEN=$HF_TOKEN
 
 ## Routing
 
-Badgr searches providers in order: own GPU hosts → Vast.ai → RunPod → TensorDock → SaladCloud. It picks the cheapest available instance that meets the GPU and region spec, then adds ~25% for routing margin and startup risk.
+Badgr automatically searches available GPU capacity across its verified compute network.
+
+Badgr automatically searches verified GPU capacity and chooses the best eligible route for your GPU type, workload, price cap, and optional region preference.
 
-Preview routing before committing:
+Preview before provisioning:
 
 ```bash
 badgr serve mistral-7b --gpu RTX_4090 --dry-run
@@ -96,7 +102,7 @@ badgr receipts        # last 10
 badgr receipts 50     # last 50
 ```
 
-Each receipt includes: receipt ID, provider, GPU, provisioning latency, rate/hr, and retry count.
+Each receipt includes: receipt ID, GPU type, provisioning latency, rate/hr, route used, retry count, and status.
 
 ---
 
@@ -109,7 +115,7 @@ from openai import OpenAI
 
 client = OpenAI(
     api_key="your-badgr-api-key",
-    base_url="https://dep-xyz.api.badgr.ai/v1",  # from badgr serve output
+    base_url="https://dep-a1b2c3.api.badgr.ai/v1",  # from badgr serve output
 )
 resp = client.chat.completions.create(
     model="meta-llama/Llama-3.1-8B-Instruct",
@@ -121,7 +127,7 @@ resp = client.chat.completions.create(
 import OpenAI from "openai";
 const client = new OpenAI({
   apiKey: process.env.BADGR_API_KEY,
-  baseURL: "https://dep-xyz.api.badgr.ai/v1",
+  baseURL: "https://dep-a1b2c3.api.badgr.ai/v1",
 });
 ```
 
@@ -129,7 +135,7 @@ const client = new OpenAI({
 
 ## GPU options
 
-| Flag value | GPU | VRAM | Est. rate/hr |
+| Flag value | GPU | VRAM | Estimated Badgr price/hr |
 |-----------|-----|------|-------------|
 | RTX_4090 | NVIDIA RTX 4090 | 24 GB | $0.65–0.89 |
 | L40S | NVIDIA L40S | 48 GB | $1.10–1.40 |
@@ -137,7 +143,7 @@ const client = new OpenAI({
 | A100 | NVIDIA A100 | 80 GB | $1.20–1.50 |
 | H100 | NVIDIA H100 | 80 GB | $2.80–3.10 |
 
-Rates are provider-level. Badgr adds ~25% for routing and startup risk.
+Prices shown are estimated Badgr rates. Final $/GPU-hour is confirmed before provisioning and may vary by GPU type, availability, region, workload, and runtime.
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "badgr-cli",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Badgr — run or serve GPU workloads from one command",
   "type": "module",
   "bin": {