Skip to content

CLI

usemuro brings the Muro catalogue and room painting to your terminal. It talks to the same server as the MCP tools. Colour lookups are free. Painting uses a Muro API key and your plan’s credits. Source: github.com/mszyma/muro-cli.

Requires Node 20 or newer. No dependencies.

Run without installing:

Terminal window
npx usemuro colors search "agreeable gray"

Or install globally. The command is then muro:

Terminal window
npm install -g usemuro
muro colors search "agreeable gray"

No key needed.

Terminal window
muro colors search "agreeable gray"
Sherwin-Williams Agreeable Gray (SW 7029) #D1CBC1 https://usemuro.com/en/colors/sherwin_williams/agreeable-gray
Terminal window
muro colors get "Farrow & Ball" "Hague Blue"
Farrow & Ball Hague Blue (30) #3D4E57 LRV 29.4 https://usemuro.com/en/colors/farrow_ball/hague-blue
Terminal window
muro colors equivalents "Farrow & Ball" "Hague Blue" --country PL --limit 4
Source: Farrow & Ball Hague Blue (30) #3D4E57
ΔE 0.49 Śnieżka S 7020-b10g (S 7020-B10G) #3D4D56 — practically identical
ΔE 1.35 Dulux (PL) S0.16.22 (1384825) #394A53 — very close
ΔE 2.33 Tikkurila M438 #435055 — close
ΔE 2.35 Flügger 4468 (Flügger Pro 5 - Flügger 900 624) #3D4951 — close

--country PL puts brands sold in that market first. See Colour data for what ΔE means.

Command What it does
muro colors search <query> [--brand B] [--limit N] Search by name or code (free)
muro colors get <brand> <name-or-code> Exact lookup (free)
muro colors equivalents <brand> <name-or-code> or --hex #RRGGBB [--country PL] [--limit N] Closest colours in other brands, CIEDE2000 (free)
muro brands [--country PL] Brands, optionally by market (free)
muro login [key] Save your API key
muro logout Remove the saved key
muro credits Show balance and plan
muro visualize <photo|url> -c <colour> … Paint 1 to 12 colours. Options: --surface interior|facade|roof, --quality standard|hd|ultra, --ceiling, --country PL, --out DIR, --yes
muro relight <project-id> <colour-key> --time day|evening|night The same result in another light, 1 credit. Options: --lamps, --out DIR

colors also answers to colours, and visualize to visualise and paint. Run muro --help for the built-in reference and muro --version for the version.

The -c option (repeatable, also --color and --colour) takes any of:

Form Example
Hex #3D4E57
Brand and name "Farrow & Ball:Hague Blue"
Brand and code "Sherwin-Williams:SW 7029"
RAL code "RAL 9005"

Give each colour once: a duplicate is refused because every colour is charged.

Create a key at app.usemuro.com → Settings → API keys (see API keys), then:

Terminal window
muro login # paste the key when asked
muro login muro_sk_… # or pass it as an argument

The key is checked against your account and saved to ~/.config/muro/config.json (readable only by you). Set MURO_API_KEY to use a key without saving it, for example in CI. The environment variable wins over the saved file.

Terminal window
muro visualize living-room.jpg \
-c "Farrow & Ball:Hague Blue" -c "RAL 9005" \
--country PL --out ./paint
1. Farrow & Ball Hague Blue (30) #3D4E57 [c1]
→ paint/01-farrow-ball-hague-blue.jpg
Buy: Śnieżka S 7020-b10g ΔE 0.49 · Dulux (PL) S0.16.22 (1384825) ΔE 1.35 · Tikkurila M438 ΔE 2.33 · Flügger 4468 ΔE 2.35
2. RAL Colors Jet black (RAL 9005) #0E0E10 [c2]
→ paint/02-ral-colors-jet-black.jpg
…
Project: https://app.usemuro.com/wynik/…
Cost: 2 credits.

Each result is saved at full resolution (default folder muro-out) with the paint’s brand, name and code, plus the closest paints to buy from other brands.

Before spending credits, visualize shows the cost and asks [y/N]. Pass --yes (or -y) to skip the question. --yes is required when the command is not run in a terminal, for example in a script.

The photo argument is a file path or an https:// link.

  • JPEG, PNG or WebP, up to 12 MB.
  • HEIC/HEIF from an iPhone is converted to JPEG automatically on macOS (using the built-in sips). On other systems, save it as JPEG first.
  • 1 to 12 colours per call, each a separate image.
  • Up to 100 photo uploads a day per account.

standard (about 1K) costs 1 credit per colour on any plan. hd (about 2K) costs 2 from Pro. ultra (about 4K) costs 3 from Premium. See Pricing and limits.

Show a painted interior by day, at evening or at night. Use the project id and colour key (c1, c2, …) from the visualize output:

Terminal window
muro relight <project-id> c1 --time evening

It costs 1 credit and saves, for example, muro-out/c1-evening.jpg. Add --lamps for lamps on. It asks for confirmation in a terminal; --yes skips it.

Every command takes --json for scripts and agents:

Terminal window
muro colors search "SW 7029" --json
{
"query": "SW 7029",
"count": 1,
"colors": [
{
"brand": "Sherwin-Williams",
"brand_id": "sherwin_williams",
"name": "Agreeable Gray",
"hex": "#D1CBC1",
"lrv": 79.8,
"category": "neutral",
"collection": "Sherwin-Williams-all",
"code": "SW 7029",
"url": "https://usemuro.com/en/colors/sherwin_williams/agreeable-gray"
}
],
"see_on_your_wall": "Preview it on a photo of your own room with Muro (iPhone, iPad and web): https://app.usemuro.com · App Store: https://apps.apple.com/app/id6757682733",
"data_source": "Muro paint colour database (usemuro.com), compiled from manufacturers’ published colour catalogues."
}

With --json, progress messages are not printed.

The CLI prints muro: <message> and exits non-zero. Common messages:

  • This needs a Muro API key. Create one at https://app.usemuro.com/ustawienia (Settings → API keys), then run: muro login
  • Your API key was not accepted. Create a new one at https://app.usemuro.com/ustawienia and run: muro login
  • This needs 3 credits and you have 1. Top up at https://app.usemuro.com/plan
  • This will use 2 credits. Add --yes to confirm.
  • The photo is larger than 12 MB.
  • HEIC photos are converted automatically only on macOS. Save the photo as JPEG first.

The server-side messages are on Errors.

The same features are available over MCP. See the MCP overview and the quickstart.