rmbg2-cli 0.4.0

package/LICENSE

@@ -0,0 +1,38 @@
+RMBG-2.0 MODEL WEIGHTS LICENSE NOTICE
+
+This repository uses the briaai/RMBG-2.0 model. The model weights are licensed
+separately by BRIA AI for non-commercial use under the Creative Commons
+Attribution-NonCommercial 4.0 International license (CC BY-NC 4.0).
+
+Model and license information:
+https://huggingface.co/briaai/RMBG-2.0
+https://creativecommons.org/licenses/by-nc/4.0/
+
+Commercial use of the model weights requires a separate agreement with BRIA.
+The notice above applies to the model weights and does not replace the MIT
+license for this repository's source code, reproduced unchanged below.
+
+-------------------------------------------------------------------------------
+
+MIT License
+
+Copyright (c) 2026 rmbg-cli contributors
+Copyright (c) 2026 rmtg contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,185 @@
+# rmbg-cli
+
+[![CI](https://github.com/shayyz-code/rmbg-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/shayyz-code/rmbg-cli/actions/workflows/ci.yml)
+[![Release](https://github.com/shayyz-code/rmbg-cli/actions/workflows/release.yml/badge.svg)](https://github.com/shayyz-code/rmbg-cli/actions/workflows/release.yml)
+[![npm](https://img.shields.io/npm/v/rmbg2-cli.svg)](https://www.npmjs.com/package/rmbg2-cli)
+[![Code License: MIT](https://img.shields.io/badge/code-MIT-blue.svg)](LICENSE)
+[![Model License: CC BY--NC 4.0](https://img.shields.io/badge/model-CC_BY--NC_4.0-orange.svg)](https://huggingface.co/briaai/RMBG-2.0)
+
+`rmbg` removes image backgrounds locally with
+[`briaai/RMBG-2.0`](https://huggingface.co/briaai/RMBG-2.0). A small Rust CLI
+validates arguments and starts a locked, uv-managed Transformers runtime. No
+hosted inference API is used.
+
+> [!IMPORTANT]
+> The RMBG-2.0 model weights are available for **non-commercial use only**
+> under CC BY-NC 4.0. Commercial use requires a separate agreement with BRIA.
+> The repository code remains MIT-licensed; that license does not extend to
+> the model weights.
+
+## Example
+
+The example below was processed locally with:
+
+```bash
+rmbg marin.png -o marin-no-bg.png
+```
+
+| Before | After — transparent PNG |
+|:------:|:-----------------------:|
+| <img width="427" height="640" alt="marin" src="https://github.com/user-attachments/assets/a810e266-607f-43d5-b8e6-845bed9f1d67" /> | <img width="427" height="640" alt="marin-no-bg" src="https://github.com/user-attachments/assets/99711dfc-6ee7-4df0-bdb1-09e7b64b8d44" /> |
+
+## System requirements
+
+BRIA publishes RMBG-2.0 as a 0.2B-parameter model with FP32 weights and a
+1024×1024 inference size, but does not publish minimum RAM or VRAM figures. The
+values below are conservative project guidance based on that architecture, the
+844 MB pinned weights, and the local PyTorch runtime. See the
+[official model card](https://huggingface.co/briaai/RMBG-2.0) and
+[BRIA repository](https://github.com/Bria-AI/RMBG-2.0).
+
+| Resource | Minimum | Recommended |
+|----------|---------|-------------|
+| Platform | Linux glibc x64/ARM64, Apple Silicon macOS, or Windows x64 | A current release of one of the supported operating systems |
+| CPU | 2 cores; CPU-only inference is supported | 4 or more modern CPU cores |
+| Memory | 8 GB RAM | 16 GB RAM |
+| Free storage | 5 GB for dependencies, weights, and caches | 10 GB, especially for Linux CUDA packages |
+| Acceleration | None; a GPU is optional | NVIDIA GPU with 6 GB VRAM, or Apple Silicon with 16 GB unified memory |
+| Network | Required during initial setup | Broadband connection for the model and dependency download |
+| Account | Hugging Face account with the RMBG-2.0 terms accepted | `HF_TOKEN` configured for non-interactive setup |
+| Software | [uv](https://docs.astral.sh/uv/) and Python 3.10–3.12, managed by uv | Node.js 18+ for npm installation; Rust 1.75+ only when building from source |
+
+The official implementation depends on PyTorch, Torchvision, Pillow, Kornia,
+and Transformers. CUDA, Apple MPS, and CPU execution are selected automatically
+by this CLI.
+
+## Installation
+
+Install the native CLI from npm:
+
+```bash
+npm install --global rmbg2-cli
+rmbg setup
+```
+
+Node.js is only used by the npm launcher. The image processing runtime remains
+local Python, Transformers, and PyTorch managed by uv.
+
+To install without Node.js on Linux or macOS:
+
+```bash
+curl --proto '=https' --tlsv1.2 -LsSf https://github.com/shayyz-code/rmbg-cli/releases/latest/download/rmbg-installer.sh | sh
+```
+
+On Windows PowerShell:
+
+```powershell
+irm https://github.com/shayyz-code/rmbg-cli/releases/latest/download/rmbg-installer.ps1 | iex
+```
+
+Both direct installers verify the downloaded archive against the release
+SHA-256 manifest, install into a user-local bin directory, and print PATH
+guidance when needed. Set `RMBG_INSTALL_DIR` to choose another directory or
+`RMBG_VERSION` to install a specific release.
+
+Then prepare the local model runtime once:
+
+```bash
+rmbg setup
+```
+
+To build from source instead:
+
+```bash
+git clone https://github.com/shayyz-code/rmbg-cli.git
+cd rmbg-cli
+cargo build --release
+./target/release/rmbg setup
+```
+
+Setup checks for [uv](https://docs.astral.sh/uv/getting-started/installation/),
+prints the official installation command if it is missing, installs the locked
+Python dependencies, starts Hugging Face login when needed, downloads the pinned
+844 MB model, and validates that it loads on the selected device. If BRIA's
+non-commercial terms have not been accepted, setup prints the model page and can
+be rerun after access is granted. You can use `HF_TOKEN` instead of interactive
+login.
+
+Setup is idempotent and reuses installed dependencies and cached weights:
+
+```bash
+rmbg setup --device cpu
+```
+
+## Usage
+
+Remove a background and write `<input>-no-bg.png`:
+
+```bash
+rmbg photo.jpg
+rmbg photo.jpg -o cutout.png -v
+```
+
+Composite the foreground onto a solid color:
+
+```bash
+rmbg photo.jpg --background white -o on-white.png
+rmbg photo.jpg --background "#336699" -o on-blue.png
+rmbg photo.jpg --background 255,128,0 -o on-orange.png
+```
+
+Device selection defaults to CUDA, then Apple MPS, then CPU. Override it when
+needed:
+
+```bash
+rmbg photo.jpg --device cpu
+```
+
+| Flag | Description |
+|------|-------------|
+| `-o, --output <PATH>` | Output PNG path (default: `<input>-no-bg.png`) |
+| `--background <COLOR>` | Solid background (`#RRGGBB`, `R,G,B`, `white`, `black`) |
+| `--device <DEVICE>` | `auto`, `cuda`, `mps`, or `cpu` (default: `auto`) |
+| `-v, --verbose` | Print model, device, revision, and output details |
+| `-h, --help` | Show help |
+
+`rmbg setup [--device auto|cuda|mps|cpu]` prepares and validates all local
+runtime prerequisites. Because `setup` is reserved as a command, process a file
+with that exact name as `rmbg ./setup`.
+
+Exit code `1` indicates invalid input or a setup action the user must complete,
+such as installing uv, authenticating non-interactively, or accepting model
+terms. Exit code `2` indicates dependency, network, runtime, model-load,
+inference, or output failure.
+
+## How it works
+
+The worker follows the RMBG-2.0 model card: it normalizes a 1024×1024 RGB copy,
+runs local Transformers/PyTorch inference, resizes the predicted grayscale
+matte to the original dimensions, and applies it as alpha. Existing alpha is
+multiplied with the prediction so transparent source pixels are never restored.
+
+The model requires `trust_remote_code=True`. The tested model revision is
+[`5df4c9c76d8170882c34f6986e848ee07fd0ba43`](https://huggingface.co/briaai/RMBG-2.0/tree/5df4c9c76d8170882c34f6986e848ee07fd0ba43),
+reported by `rmbg -v`. It can be overridden for deliberate maintenance with
+`RMBG_MODEL_REVISION`.
+
+## Development
+
+```bash
+uv sync --project runtime --frozen
+cargo fmt --all -- --check
+cargo clippy --all-targets -- -D warnings
+cargo test --all
+npm run check:versions
+npm test
+uv run --project runtime --frozen python runtime/tests/test_runtime.py
+```
+
+Ordinary tests use a fake segmentation model and do not download weights.
+
+## License
+
+Repository code is MIT-licensed. RMBG-2.0 model weights are separately licensed
+for non-commercial use under CC BY-NC 4.0. See [LICENSE](LICENSE) and the
+[official model card](https://huggingface.co/briaai/RMBG-2.0).

package/npm/bin/rmbg.js

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+
+"use strict";
+
+const path = require("node:path");
+const { spawn } = require("node:child_process");
+const { packageForCurrentPlatform } = require("../lib/platform");
+
+let platformPackage;
+try {
+  platformPackage = packageForCurrentPlatform();
+} catch (error) {
+  console.error(`rmbg: ${error.message}`);
+  process.exit(1);
+}
+
+let packageJson;
+try {
+  packageJson = require.resolve(`${platformPackage}/package.json`);
+} catch {
+  console.error(
+    `rmbg: native package ${platformPackage} is missing. ` +
+      "Reinstall rmbg2-cli without omitting optional dependencies."
+  );
+  process.exit(1);
+}
+
+const executable = path.join(
+  path.dirname(packageJson),
+  "bin",
+  process.platform === "win32" ? "rmbg.exe" : "rmbg"
+);
+const child = spawn(executable, process.argv.slice(2), { stdio: "inherit" });
+
+child.on("error", (error) => {
+  console.error(`rmbg: failed to start native executable: ${error.message}`);
+  process.exit(1);
+});
+
+for (const signal of ["SIGINT", "SIGTERM"]) {
+  process.on(signal, () => child.kill(signal));
+}
+
+child.on("exit", (code, signal) => {
+  if (signal) {
+    process.kill(process.pid, signal);
+    return;
+  }
+  process.exit(code ?? 1);
+});

package/npm/lib/platform.js

@@ -0,0 +1,33 @@
+"use strict";
+
+const PACKAGES = new Map([
+  ["darwin-arm64", "rmbg2-cli-darwin-arm64"],
+  ["linux-arm64", "rmbg2-cli-linux-arm64-gnu"],
+  ["linux-x64", "rmbg2-cli-linux-x64-gnu"],
+  ["win32-x64", "rmbg2-cli-win32-x64-msvc"]
+]);
+
+function usesGlibc(report = process.report) {
+  if (!report || typeof report.getReport !== "function") return false;
+  return Boolean(report.getReport().header?.glibcVersionRuntime);
+}
+
+function packageForPlatform(platform, arch, report = process.report) {
+  if (platform === "linux" && !usesGlibc(report)) {
+    throw new Error("Linux musl is not supported; a glibc-based distribution is required");
+  }
+
+  const packageName = PACKAGES.get(`${platform}-${arch}`);
+  if (!packageName) {
+    throw new Error(
+      `unsupported platform ${platform}/${arch}; supported targets are Linux x64/ARM64 (glibc), macOS ARM64, and Windows x64`
+    );
+  }
+  return packageName;
+}
+
+function packageForCurrentPlatform() {
+  return packageForPlatform(process.platform, process.arch);
+}
+
+module.exports = { packageForCurrentPlatform, packageForPlatform, usesGlibc };

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "rmbg2-cli",
+  "version": "0.4.0",
+  "description": "Remove image backgrounds locally with BRIA RMBG-2.0",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shayyz-code/rmbg-cli.git"
+  },
+  "homepage": "https://github.com/shayyz-code/rmbg-cli#readme",
+  "engines": {
+    "node": ">=18"
+  },
+  "bin": {
+    "rmbg": "npm/bin/rmbg.js"
+  },
+  "files": [
+    "npm/bin",
+    "npm/lib",
+    "README.md",
+    "LICENSE"
+  ],
+  "optionalDependencies": {
+    "rmbg2-cli-darwin-arm64": "0.4.0",
+    "rmbg2-cli-linux-arm64-gnu": "0.4.0",
+    "rmbg2-cli-linux-x64-gnu": "0.4.0",
+    "rmbg2-cli-win32-x64-msvc": "0.4.0"
+  },
+  "scripts": {
+    "check:versions": "node npm/scripts/check-versions.js",
+    "test": "node --test npm/tests/*.test.js"
+  }
+}