nvicode 0.1.11 → 0.1.13

package/README.md

@@ -1,30 +1,115 @@
-# NviCode
+# NviCode - Introducing one click Nvidia/OpenRouter keys to Claude Code. Free Claude code.
 
-Connect Claude Code to NVIDIA or OpenRouter.
+[![CI](https://github.com/dineshpotla/nvicode/actions/workflows/ci.yml/badge.svg)](https://github.com/dineshpotla/nvicode/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/nvicode)](https://www.npmjs.com/package/nvicode)
+[![package](https://img.shields.io/badge/package-nvicode-orange)](https://www.npmjs.com/package/nvicode)
+[![node >=20](https://img.shields.io/badge/node-%3E%3D20-339933)](https://nodejs.org/)
+[![license: MIT](https://img.shields.io/badge/license-MIT-blue)](./LICENSE)
 
-## Install
+Internally, `nvicode` sits between Claude Code and the selected provider.
+For NVIDIA, it starts a local Anthropic-compatible proxy that translates Claude Code requests to NVIDIA chat completions.
+For OpenRouter, it points Claude Code directly at OpenRouter's compatible endpoint and applies the selected model configuration.
+
+Supported environments:
+- macOS
+- Ubuntu/Linux
+- WSL
+- Native Windows with Claude Code installed and working from PowerShell, CMD, or Git Bash
+
+## Quickstart
+
+Install the published package:
 
 ```sh
 npm install -g nvicode
 ```
 
-## Setup
+Set up provider, key, and model:
 
 ```sh
 nvicode select model
 ```
 
-NVIDIA keys: [https://build.nvidia.com/settings/api-keys](https://build.nvidia.com/settings/api-keys)
+The setup flow asks for provider, API key, and model:
+
+- NVIDIA: get a free key from [NVIDIA Build API Keys](https://build.nvidia.com/settings/api-keys)
+- OpenRouter: use your OpenRouter API key
 
-## Launch
+Launch Claude Code through your selected provider:
 
 ```sh
 nvicode launch claude
 ```
 
-After the first successful launch, plain `claude` continues to use the selected `nvicode` provider and model.
+The first successful `nvicode launch claude` also installs persistent plain-`claude` routing.
+After that, restarting your terminal or PC and running:
+
+```sh
+claude
+```
+
+will continue using your selected `nvicode` provider and model.
+
+## Screenshots
+
+### Save your API key
+
+![nvicode auth](https://raw.githubusercontent.com/dineshpotla/nvicode/main/assets/screenshots/auth.png)
+
+### Choose a model
+
+![nvicode select model](https://raw.githubusercontent.com/dineshpotla/nvicode/main/assets/screenshots/select-model.png)
+
+### Launch Claude Code through your selected provider
+
+![nvicode launch claude](https://raw.githubusercontent.com/dineshpotla/nvicode/main/assets/screenshots/launch.png)
+
+## Commands
+
+Useful commands:
+
+```sh
+nvicode dashboard
+nvicode usage
+nvicode activity
+nvicode models
+nvicode config
+nvicode auth
+nvicode launch claude -p "Reply with exactly OK"
+```
+
+Provider behavior:
+- NVIDIA: starts a local proxy on `127.0.0.1:8788`, points Claude Code at it with `ANTHROPIC_BASE_URL`, and forwards requests to NVIDIA `chat/completions`.
+- OpenRouter: points Claude Code directly at `https://openrouter.ai/api` using OpenRouter credentials and Anthropic-compatible model ids.
+
+In an interactive terminal, `nvicode usage` refreshes live every 2 seconds. When piped or redirected, it prints a single snapshot.
+
+`nvicode select model` now asks for provider, optional API key update, and model choice in one guided flow.
+If no API key is saved for the active provider yet, `nvicode` prompts for one on first use.
+By default, the proxy paces upstream NVIDIA requests at `40 RPM`. Override that with `NVICODE_MAX_RPM` if your account has a different limit.
+The usage dashboard compares your local NVIDIA run cost against Claude Opus 4.6 at `$5 / MTok input` and `$25 / MTok output`, based on Anthropic pricing as of `2026-03-30`.
+If your NVIDIA endpoint is not free, override local cost estimates with `NVICODE_INPUT_USD_PER_MTOK` and `NVICODE_OUTPUT_USD_PER_MTOK`.
+Local `usage`, `activity`, and `dashboard` commands are available for NVIDIA proxy sessions. OpenRouter sessions use OpenRouter's direct connection path instead.
 
 ## Requirements
 
-- Claude Code must already be installed
-- Node.js 20 or newer
+- Claude Code must already be installed on the machine.
+- Node.js 20 or newer is required to install `nvicode`.
+- On native Windows, Claude Code itself requires Git for Windows. See the [Claude Code setup docs](https://code.claude.com/docs/en/setup).
+
+## Local Development
+
+These steps are only for contributors working from a git checkout. End users do not need them.
+
+```sh
+npm install
+npm run build
+npm link
+```
+
+## Notes
+
+- `thinking` is disabled by default because some NVIDIA reasoning models can consume the entire output budget and return no visible answer to Claude Code.
+- The proxy supports basic text, tool calls, tool results, and token count estimation.
+- The proxy includes upstream request pacing and retries on NVIDIA `429` responses.
+- Claude Code remains the frontend; the selected provider/model becomes the backend.

package/dist/postinstall.js

@@ -1,4 +1,5 @@
 import { spawnSync } from "node:child_process";
+import { promises as fs } from "node:fs";
 import path from "node:path";
 import process from "node:process";
 import { fileURLToPath } from "node:url";
@@ -7,6 +8,48 @@ const isTruthy = (value) => value === "1" || value === "true" || value === "yes"
 const isGlobalInstall = () => process.env.npm_config_global === "true" ||
     process.env.npm_config_location === "global";
 const isInteractive = () => Boolean(process.stdin.isTTY && process.stdout.isTTY);
+const getCliPath = () => path.join(path.dirname(fileURLToPath(import.meta.url)), "cli.js");
+const getGlobalBinDir = () => {
+    const prefix = process.env.npm_config_prefix || process.env.PREFIX;
+    if (!prefix) {
+        return null;
+    }
+    return process.platform === "win32" ? prefix : path.join(prefix, "bin");
+};
+const createGlobalLauncher = async () => {
+    const binDir = getGlobalBinDir();
+    if (!binDir) {
+        return "skipped";
+    }
+    const cliPath = getCliPath();
+    const launcherPath = process.platform === "win32"
+        ? path.join(binDir, "nvicode.cmd")
+        : path.join(binDir, "nvicode");
+    const launcherContents = process.platform === "win32"
+        ? [
+            "@echo off",
+            `node "${cliPath}" %*`,
+            "",
+        ].join("\r\n")
+        : [
+            "#!/bin/sh",
+            `exec node "${cliPath}" "$@"`,
+            "",
+        ].join("\n");
+    try {
+        await fs.lstat(launcherPath);
+        return "skipped";
+    }
+    catch {
+        // create launcher only when npm did not create the command entry
+    }
+    await fs.mkdir(binDir, { recursive: true });
+    await fs.writeFile(launcherPath, launcherContents, "utf8");
+    if (process.platform !== "win32") {
+        await fs.chmod(launcherPath, 0o755);
+    }
+    return "created";
+};
 const main = async () => {
     if (isTruthy(process.env.NVICODE_SKIP_POSTINSTALL) || isTruthy(process.env.CI)) {
         return;
@@ -14,6 +57,12 @@ const main = async () => {
     if (!isGlobalInstall()) {
         return;
     }
+    try {
+        await createGlobalLauncher();
+    }
+    catch {
+        // keep install resilient even if the launcher cannot be created manually
+    }
     if (!isInteractive()) {
         console.log("nvicode installed. Run `nvicode select model` to finish setup.");
         return;
@@ -27,7 +76,7 @@ const main = async () => {
     console.log("nvicode installed. Starting guided setup.");
     console.log("If you want to skip now, press Ctrl+C and run `nvicode select model` later.");
     console.log("");
-    const cliPath = path.join(path.dirname(fileURLToPath(import.meta.url)), "cli.js");
+    const cliPath = getCliPath();
     const result = spawnSync(process.execPath, [cliPath, "select", "model"], {
         stdio: "inherit",
         env: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nvicode",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "description": "NviCode - Introducing one click Nvidia/OpenRouter keys to Claude Code. Free Claude code.",
   "author": "Dinesh Potla",
   "keywords": [
@@ -17,7 +17,7 @@
     "nvicode": "dist/cli.js"
   },
   "scripts": {
-    "build": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true,maxRetries:10,retryDelay:100})\" && tsc -p tsconfig.json",
+    "build": "tsc -p tsconfig.json",
     "prepack": "npm run build",
     "postinstall": "node dist/postinstall.js",
     "typecheck": "tsc --noEmit",