CLI docs

Install, activate, and run the CLI with confidence.

Follow this guide in order: install, activate, verify, then run your first image.

1) Install CLI

Run installer and verify the binary.

curl -fsSL https://local.backgroundrm.com/install | bash

rmbg --version

2) Activate license

Activate your CLI key on this machine.

rmbg license activate --key YOUR_KEY --surface cli --format json

rmbg license status --surface cli --format json

3) Run first image

Ensure model files, then process an input image.

rmbg model ensure --surface cli --format json

rmbg remove --surface cli --input ./input.jpg --output ./input_rmbg.png --format json

Command reference

Core commands you will use most often.

Download and install the latest macOS CLI build

Creates an rmbg symlink in ~/.local/bin by default.

curl -fsSL https://local.backgroundrm.com/install | bash

Activate your CLI entitlement on this machine

Required before running model ensure or remove.

rmbg license activate --key YOUR_KEY --surface cli --format json

Read local activation state for the CLI surface

Useful for health checks in scripts and CI.

rmbg license status --surface cli --format json

Bootstrap the local model if files are missing

Defaults to ~/.cache/background-removal/models/birefnet.

rmbg model ensure --surface cli --format json

Remove a background from one image

Input accepts local paths and http/https image URLs.

rmbg remove --surface cli --input ./input.jpg --output ./input_rmbg.png --format json

Show top-level command help

Use rmbg <command> --help for command-specific docs.

rmbg --help

Desktop + CLI workflow

For bundle workflows, require both surfaces before processing.

Use both licenses for bundle workflows

Require desktop and CLI surfaces when your automation depends on both.

rmbg remove --surface cli --require-surface desktop --input ./input.jpg --output ./input_rmbg.png --format json

Exit codes

Use these for shell scripts and automation logic.

0Success

2Input image read or validation failure

3Model bootstrap or model availability failure

4Inference failure

5Output image write failure

6License activation or validation failure

Built-in help

See every flag directly from the CLI.

rmbg --help

rmbg remove --help