SDKs

unbg currently ships as:

• A browser-first JS/TS SDK for web apps
• A Rust workspace that powers the CLI and consumer integrations (Tauri / mobile)

The SDK software terms do not grant rights to redistribute or commercially use every supported model. Review the model license notice and the upstream model card for the exact revision you select.

Choose an SDK surface#

• Building a web app with local inference: use the Browser SDK
• Building Rust-first tooling or native integrations: use the Core SDK workspace

Browser SDK (JS/TS)#

Repository: unbgio/browser-sdk

Use this if you want local, on-device background removal inside a web app. It provides:

• A one-liner API (removeBackground(...)) for quick onboarding
• A client API (createClient(...)) for repeated workloads and lifecycle control
• WebGPU-first execution with WASM fallback for compatibility

Install:

npm install @unbg/browser-sdk

Then start with removeBackground(...) for quick use, or switch to createClient(...) when you need repeated workloads and lifecycle control.

Core SDK (Rust workspace)#

Repository: unbgio/core-sdk

Use this if you want Rust-first local inference and tooling. The workspace includes:

• unbg CLI (apps/unbg-cli)
• Shared inference contracts and policies (crates/unbg-core)
• Installer + model verification (crates/unbg-installer, crates/unbg-model-registry)
• Integration surfaces for Tauri, Android, and iOS

If you just want the CLI, the repo provides installers:

Windows (PowerShell)#

irm https://unbg.io/install.ps1 | iex

macOS / Linux#

curl -fsSL https://unbg.io/install.sh | sh

Related docs#

• CLI command docs: CLI
• Web app user docs: Web App