helpofai 0.8.62

package/README.md

@@ -0,0 +1,114 @@
+# helpofai
+
+> The terminal coding agent for any model — open models first.
+
+HelpOfAi is a Rust TUI and CLI for 24 providers — DeepSeek, OpenRouter,
+Hugging Face, and local vLLM/SGLang/Ollama are first-class routes, and it
+speaks natively to Anthropic Claude and OpenAI when that's what you have —
+with approval-gated tools, OS sandboxing, side-git snapshots, and `/restore`
+rollback.
+
+This npm package is a small launcher: it downloads the matching native
+HelpOfAi binaries for your platform, verifies them against the release
+SHA-256 manifest, and installs the `helpofai`, `hoa`, and `helpofai-tui`
+commands. The application state and credentials still live in HelpOfAi's
+normal config files, not inside `node_modules`.
+
+> Previously published as `deepseek-tui`. See
+> [docs/REBRAND.md](https://github.com/helpofai/HelpOfAi-Cli/blob/main/docs/REBRAND.md)
+> for the migration notes; the legacy `deepseek-tui` npm package is deprecated
+> and receives no further releases.
+
+## Install
+
+```bash
+npm install -g helpofai
+# or
+pnpm add -g helpofai
+```
+
+For project-local usage:
+
+```bash
+npm install helpofai
+npx helpofai --help
+```
+
+`postinstall` tries to download platform binaries into `bin/downloads/`. If
+GitHub release assets are temporarily unreachable, install continues and the
+wrapper retries the download on first run.
+
+## First run
+
+```bash
+helpofai auth set --provider deepseek
+helpofai auth status
+helpofai doctor
+helpofai
+```
+
+Every provider is the same one-line shape — `--provider openrouter`,
+`--provider huggingface`, `--provider ollama`, or `--provider anthropic` for a
+Claude key; the full registry lives in
+[docs/PROVIDERS.md](https://github.com/helpofai/HelpOfAi-Cli/blob/main/docs/PROVIDERS.md).
+
+The `helpofai` facade and `helpofai-tui` binary share
+`~/.helpofai/config.toml` for auth and default model settings. Legacy
+`~/.deepseek/config.toml` installs are still read as a compatibility fallback.
+Common TUI commands are available directly through the facade, including
+`helpofai doctor`, `helpofai models`, `helpofai sessions`, and
+`helpofai resume --last`.
+
+## Supported platforms
+
+Prebuilt binaries for the GitHub release are downloaded automatically:
+
+- Linux x64
+- Linux arm64
+- Linux riscv64
+- macOS x64 / arm64
+- Windows x64
+
+HarmonyOS PC (`openharmony`) is treated as `linux`, so it gets the Linux
+binaries matching your CPU architecture (x64, arm64, or riscv64). Other
+platform/architecture combinations (musl, 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 helpofai-cli helpofai-tui --locked` and the full
+[docs/INSTALL.md](https://github.com/helpofai/HelpOfAi-Cli/blob/main/docs/INSTALL.md)
+build-from-source guide.
+
+## Wrapper configuration
+
+| Setting | What it does |
+| --- | --- |
+| `helpofaiBinaryVersion` in `package.json` | Default native binary version. `deepseekBinaryVersion` is still read as a backward-compat fallback. |
+| `HELPOFAI_RELEASE_BASE_URL` | Canonical override: use an internal or mirrored release-asset directory when GitHub Releases is unavailable. The directory must contain `helpofai-artifacts-sha256.txt` and the platform binaries. `DEEPSEEK_TUI_RELEASE_BASE_URL` and `DEEPSEEK_RELEASE_BASE_URL` are the implemented legacy fallbacks. |
+| `HELPOFAI_USE_CNB_MIRROR=1` | Download release assets from the CNB (China-friendly) mirror instead of GitHub. |
+| `DEEPSEEK_TUI_VERSION` or `DEEPSEEK_VERSION` | Override the GitHub release version to download. |
+| `DEEPSEEK_TUI_GITHUB_REPO` or `DEEPSEEK_GITHUB_REPO` | Override the source repo. Defaults to `helpofai/HelpOfAi-Cli`. |
+| `DEEPSEEK_TUI_FORCE_DOWNLOAD=1` | Force download even when the cached binary is already present. |
+| `DEEPSEEK_TUI_DISABLE_INSTALL=1` | Skip install-time download. |
+| `DEEPSEEK_TUI_OPTIONAL_INSTALL=1` | Make install-time retryable download failures warn and exit `0` instead of failing `npm install`. |
+| `DEEPSEEK_TUI_SKIP_GLIBC_CHECK=1` | Bypass the Linux glibc preflight check at your own risk (`DEEPSEEK_SKIP_GLIBC_CHECK=1` also works). |
+
+### Proxies
+
+Downloads respect `HTTPS_PROXY` / `HTTP_PROXY` (CONNECT tunneling included)
+and `NO_PROXY`, so the wrapper works behind corporate proxies. For fully
+offline installs, set `DEEPSEEK_TUI_DISABLE_INSTALL=1` or point
+`HELPOFAI_RELEASE_BASE_URL` at a local mirror.
+
+## 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.
+
+## Links
+
+- Repository: <https://github.com/helpofai/HelpOfAi-Cli>
+- Website: <https://helpofai.net/>
+- Provider registry: [docs/PROVIDERS.md](https://github.com/helpofai/HelpOfAi-Cli/blob/main/docs/PROVIDERS.md)
+- Changelog: [CHANGELOG.md](https://github.com/helpofai/HelpOfAi-Cli/blob/main/CHANGELOG.md)

package/bin/helpofai-tui.js

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

package/bin/helpofai.js

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

package/bin/hoa.js

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

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "helpofai",
+  "version": "0.8.62",
+  "helpofaiBinaryVersion": "0.8.62",
+  "description": "Install and run HelpOfAi, the agentic terminal for open-source and open-weight coding models, from GitHub release artifacts.",
+  "author": "helpofai",
+  "license": "MIT",
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/helpofai"
+    },
+    {
+      "type": "buymeacoffee",
+      "url": "https://www.buymeacoffee.com/helpofai"
+    }
+  ],
+  "homepage": "https://github.com/helpofai/HelpOfAi-Cli",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/helpofai/HelpOfAi-Cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/helpofai/HelpOfAi-Cli/issues"
+  },
+  "keywords": [
+    "helpofai",
+    "deepseek",
+    "cli",
+    "tui",
+    "rust",
+    "binary",
+    "terminal"
+  ],
+  "type": "commonjs",
+  "bin": {
+    "helpofai": "bin/helpofai.js",
+    "hoa": "bin/hoa.js",
+    "helpofai-tui": "bin/helpofai-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,136 @@
+const path = require("path");
+const os = require("os");
+
+const CHECKSUM_MANIFEST = "helpofai-artifacts-sha256.txt";
+
+const ASSET_MATRIX = {
+  linux: {
+    x64: ["helpofai-linux-x64", "helpofai-tui-linux-x64"],
+    arm64: ["helpofai-linux-arm64", "helpofai-tui-linux-arm64"],
+    riscv64: ["helpofai-linux-riscv64", "helpofai-tui-linux-riscv64"],
+  },
+  darwin: {
+    x64: ["helpofai-macos-x64", "helpofai-tui-macos-x64"],
+    arm64: ["helpofai-macos-arm64", "helpofai-tui-macos-arm64"],
+  },
+  win32: {
+    x64: ["helpofai-windows-x64.exe", "helpofai-tui-windows-x64.exe", "helpofai.bat"],
+  },
+};
+
+// 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,
+    helpofai: pair[0],
+    tui: pair[1],
+  };
+}
+
+function unsupportedBuildHint() {
+  return [
+    "No prebuilt binary is available for this platform/architecture combo.",
+    "You can still run helpofai by building from source with Cargo:",
+    "",
+    "  # Requires Rust 1.88+ (https://rustup.rs)",
+    "  cargo install helpofai-cli --locked   # provides `helpofai`",
+    "  cargo install helpofai-tui --locked   # provides `helpofai-tui`",
+    "",
+    "Or build from a checkout:",
+    "",
+    "  git clone https://github.com/helpofai/HelpOfAi-Cli.git",
+    "  cd HelpOfAi",
+    "  cargo install --path crates/cli --locked",
+    "  cargo install --path crates/tui --locked",
+    "",
+    "See https://github.com/helpofai/HelpOfAi-Cli/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 = "helpofai/HelpOfAi-Cli") {
+  // HELPOFAI_RELEASE_BASE_URL is the canonical override.
+  // DEEPSEEK_TUI_RELEASE_BASE_URL / DEEPSEEK_RELEASE_BASE_URL are legacy aliases.
+  const override =
+    process.env.HELPOFAI_RELEASE_BASE_URL ||
+    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}/`;
+  }
+  // When HELPOFAI_USE_CNB_MIRROR is set, use the CNB (China-friendly)
+  // mirror that already builds and publishes binary release assets.
+  if (process.env.HELPOFAI_USE_CNB_MIRROR) {
+    return `https://cnb.cool/helpofai/HelpOfAi-Cli/-/releases/v${version}/`;
+  }
+  return `https://github.com/${repo}/releases/download/v${version}/`;
+}
+
+function releaseAssetUrl(baseName, version, repo = "helpofai/HelpOfAi-Cli") {
+  return new URL(baseName, releaseBaseUrl(version, repo)).toString();
+}
+
+function checksumManifestUrl(version, repo = "helpofai/HelpOfAi-Cli") {
+  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 assets of Object.values(platformAssets)) {
+      names.push(...assets);
+    }
+  }
+  return Array.from(new Set(names));
+}
+
+function allReleaseAssetNames() {
+  return [...allAssetNames(), CHECKSUM_MANIFEST];
+}
+
+module.exports = {
+  allAssetNames,
+  allReleaseAssetNames,
+  CHECKSUM_MANIFEST,
+  checksumManifestUrl,
+  detectBinaryNames,
+  executableName,
+  releaseAssetUrl,
+  releaseBaseUrl,
+  releaseBinaryDirectory,
+};