codewhale 0.8.41

package/README.md

@@ -0,0 +1,94 @@
+# codewhale
+
+Install and run the `codewhale` and `codewhale-tui` binaries from GitHub release artifacts.
+
+> Previously published as `deepseek-tui`. See `docs/REBRAND.md` in the upstream
+> repository for the migration notes; the legacy `deepseek-tui` npm package
+> still exists as a deprecation shim for one release cycle.
+
+## Install
+
+```bash
+npm install -g codewhale
+# or
+pnpm add -g codewhale
+```
+
+For project-local usage:
+
+```bash
+npm install codewhale
+npx codewhale --help
+```
+
+`postinstall` tries to download platform binaries into `bin/downloads/` and
+exposes `codewhale` and `codewhale-tui` commands. If GitHub release assets are
+temporarily unreachable, install continues and the wrapper retries the download
+on first run.
+
+## First run
+
+```bash
+codewhale login --api-key "YOUR_DEEPSEEK_API_KEY"
+codewhale doctor
+codewhale
+```
+
+The `codewhale` facade and `codewhale-tui` binary share `~/.deepseek/config.toml`
+for DeepSeek auth and default model settings. Common TUI commands are available
+directly through the facade, including `codewhale doctor`, `codewhale models`,
+`codewhale sessions`, and `codewhale resume --last`.
+
+The app talks to DeepSeek's documented OpenAI-compatible Chat Completions API.
+Set `DEEPSEEK_BASE_URL` only if you need the China endpoint or DeepSeek beta
+features such as strict tool mode, chat prefix completion, or FIM completion.
+
+NVIDIA NIM-hosted DeepSeek V4 Pro is also supported:
+
+```bash
+codewhale auth set --provider nvidia-nim --api-key "YOUR_NVIDIA_API_KEY"
+codewhale --provider nvidia-nim
+```
+
+For a single process, set `DEEPSEEK_PROVIDER=nvidia-nim` and `NVIDIA_API_KEY`
+or `NVIDIA_NIM_API_KEY` (with `DEEPSEEK_API_KEY` as a compatibility fallback).
+The NIM default model is `deepseek-ai/deepseek-v4-pro` and the default base URL
+is `https://integrate.api.nvidia.com/v1`. With `--provider nvidia-nim`,
+`--model deepseek-v4-flash` maps to `deepseek-ai/deepseek-v4-flash`.
+
+## Supported platforms
+
+Prebuilt binaries for the GitHub release are downloaded automatically:
+
+- Linux x64
+- Linux arm64 (v0.8.8+)
+- macOS x64 / arm64
+- Windows x64
+
+Other platform/architecture combinations (musl, riscv64, FreeBSD, …) aren't
+shipped as prebuilts. Unsupported platforms, checksum failures, and glibc
+compatibility problems still fail with a clear error pointing you at
+`cargo install codewhale-cli codewhale-tui --locked` and the full
+[docs/INSTALL.md](https://github.com/Hmbown/CodeWhale/blob/main/docs/INSTALL.md)
+build-from-source guide.
+
+## Configuration
+
+- Default binary version comes from `codewhaleBinaryVersion` in `package.json`
+  (with `deepseekBinaryVersion` as a backward-compat fallback).
+- Set `DEEPSEEK_TUI_VERSION` or `DEEPSEEK_VERSION` to override the release version.
+- Set `DEEPSEEK_TUI_GITHUB_REPO` or `DEEPSEEK_GITHUB_REPO` to override the source repo (defaults to `Hmbown/CodeWhale`).
+- Set `DEEPSEEK_TUI_RELEASE_BASE_URL` to use an internal or mirrored
+  release-asset directory when GitHub Releases is unavailable. The directory
+  must contain `codewhale-artifacts-sha256.txt` and the platform binaries.
+- Set `DEEPSEEK_TUI_FORCE_DOWNLOAD=1` to force download even when the cached binary is already present.
+- Set `DEEPSEEK_TUI_DISABLE_INSTALL=1` to skip install-time download.
+- Set `DEEPSEEK_TUI_OPTIONAL_INSTALL=1` to make install-time retryable download
+  failures warn and exit `0` instead of failing `npm install`.
+
+## Release integrity
+
+- `npm publish` runs a release-asset check to ensure all required binary assets
+  exist for the target GitHub release before publishing.
+- Install-time downloads are verified against the release checksum manifest before
+  the wrapper marks them executable.

package/bin/codewhale-tui.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+const { runCodeWhaleTui } = require("../scripts/run");
+
+runCodeWhaleTui().catch((error) => {
+  console.error("Failed to start codewhale-tui:", error.message);
+  process.exit(1);
+});

package/bin/codewhale.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+
+const { runCodeWhale } = require("../scripts/run");
+
+runCodeWhale().catch((error) => {
+  console.error("Failed to start codewhale:", error.message);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "codewhale",
+  "version": "0.8.41",
+  "codewhaleBinaryVersion": "0.8.41",
+  "description": "Install and run the codewhale CLI dispatcher and codewhale-tui terminal UI from GitHub release artifacts.",
+  "author": "Hmbown",
+  "license": "MIT",
+  "homepage": "https://github.com/Hmbown/CodeWhale",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Hmbown/CodeWhale.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Hmbown/CodeWhale/issues"
+  },
+  "keywords": [
+    "codewhale",
+    "deepseek",
+    "cli",
+    "tui",
+    "rust",
+    "binary",
+    "terminal"
+  ],
+  "type": "commonjs",
+  "bin": {
+    "codewhale": "bin/codewhale.js",
+    "codewhale-tui": "bin/codewhale-tui.js"
+  },
+  "scripts": {
+    "release:check": "node scripts/verify-release-assets.js",
+    "postinstall": "node scripts/install.js --optional",
+    "prepublishOnly": "node scripts/verify-release-assets.js",
+    "prepack": "node scripts/install.js",
+    "test": "node --test test/*.test.js"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "preferGlobal": true,
+  "files": [
+    "bin/*.js",
+    "scripts/*.js",
+    "test/*.js",
+    "README.md",
+    "package.json"
+  ]
+}

package/scripts/artifacts.js

@@ -0,0 +1,126 @@
+const path = require("path");
+const os = require("os");
+
+const CHECKSUM_MANIFEST = "codewhale-artifacts-sha256.txt";
+
+const ASSET_MATRIX = {
+  linux: {
+    x64: ["codewhale-linux-x64", "codewhale-tui-linux-x64"],
+    arm64: ["codewhale-linux-arm64", "codewhale-tui-linux-arm64"],
+  },
+  darwin: {
+    x64: ["codewhale-macos-x64", "codewhale-tui-macos-x64"],
+    arm64: ["codewhale-macos-arm64", "codewhale-tui-macos-arm64"],
+  },
+  win32: {
+    x64: ["codewhale-windows-x64.exe", "codewhale-tui-windows-x64.exe"],
+  },
+};
+
+// HarmonyPC (openharmony) is an x86_64 Linux-compatible environment; map it to
+// the linux binary family so npm install succeeds without a separate build target.
+const PLATFORM_ALIASES = {
+  openharmony: "linux",
+};
+
+function detectBinaryNames() {
+  const rawPlatform = os.platform();
+  const platform = PLATFORM_ALIASES[rawPlatform] || rawPlatform;
+  const arch = os.arch();
+  const defaults = ASSET_MATRIX[platform];
+  if (!defaults) {
+    const supported = Object.keys(ASSET_MATRIX).map(p => `'${p}'`).join(', ');
+    throw new Error(
+      `Unsupported platform: ${rawPlatform}. Supported platforms: ${supported}.\n\n` +
+      unsupportedBuildHint(),
+    );
+  }
+  const pair = defaults[arch];
+  if (!pair) {
+    const supported = Object.keys(defaults).map(a => `'${a}'`).join(', ');
+    throw new Error(
+      `Unsupported architecture: ${arch} on platform ${platform}. ` +
+      `Supported architectures: ${supported}.\n\n` +
+      unsupportedBuildHint(),
+    );
+  }
+  return {
+    platform,
+    arch,
+    codewhale: pair[0],
+    tui: pair[1],
+  };
+}
+
+function unsupportedBuildHint() {
+  return [
+    "No prebuilt binary is available for this platform/architecture combo.",
+    "You can still run codewhale by building from source with Cargo:",
+    "",
+    "  # Requires Rust 1.88+ (https://rustup.rs)",
+    "  cargo install codewhale-cli --locked   # provides `codewhale`",
+    "  cargo install codewhale-tui --locked   # provides `codewhale-tui`",
+    "",
+    "Or build from a checkout:",
+    "",
+    "  git clone https://github.com/Hmbown/CodeWhale.git",
+    "  cd CodeWhale",
+    "  cargo install --path crates/cli --locked",
+    "  cargo install --path crates/tui --locked",
+    "",
+    "See https://github.com/Hmbown/CodeWhale/blob/main/docs/INSTALL.md",
+    "for cross-compilation, mirror, and Linux ARM64 specifics.",
+  ].join("\n");
+}
+
+function executableName(base, platform) {
+  return platform === "win32" ? `${base}.exe` : base;
+}
+
+function releaseBaseUrl(version, repo = "Hmbown/CodeWhale") {
+  const override =
+    process.env.DEEPSEEK_TUI_RELEASE_BASE_URL || process.env.DEEPSEEK_RELEASE_BASE_URL;
+  if (override) {
+    const trimmed = String(override).trim();
+    return trimmed.endsWith("/") ? trimmed : `${trimmed}/`;
+  }
+  return `https://github.com/${repo}/releases/download/v${version}/`;
+}
+
+function releaseAssetUrl(baseName, version, repo = "Hmbown/CodeWhale") {
+  return new URL(baseName, releaseBaseUrl(version, repo)).toString();
+}
+
+function checksumManifestUrl(version, repo = "Hmbown/CodeWhale") {
+  return releaseAssetUrl(CHECKSUM_MANIFEST, version, repo);
+}
+
+function releaseBinaryDirectory() {
+  return path.join(__dirname, "..", "bin", "downloads");
+}
+
+function allAssetNames() {
+  const names = [];
+  for (const platformAssets of Object.values(ASSET_MATRIX)) {
+    for (const pair of Object.values(platformAssets)) {
+      names.push(pair[0], pair[1]);
+    }
+  }
+  return Array.from(new Set(names));
+}
+
+function allReleaseAssetNames() {
+  return [...allAssetNames(), CHECKSUM_MANIFEST];
+}
+
+module.exports = {
+  allAssetNames,
+  allReleaseAssetNames,
+  CHECKSUM_MANIFEST,
+  checksumManifestUrl,
+  detectBinaryNames,
+  executableName,
+  releaseAssetUrl,
+  releaseBaseUrl,
+  releaseBinaryDirectory,
+};