urbrandsource

Sync production brand assets from Urbrandsource Main to your app.

npm: urbrandsource · Docs: urbrandsource.com/docs

Install

npm install -D urbrandsource

Or run without installing:

npx urbrandsource pull <brand> --main --out ./public/brands

Authentication (env only — never paste keys in commands)

URBRANDSOURCE_API_KEY=
URBRANDSOURCE_API_URL=https://app.urbrandsource.com

The CLI loads .env, .env.local, and parent directories automatically. Works on Vercel, GitHub Actions, and local dev.

Create API keys in Urbrandsource → Settings → API keys (main:read scope).

Automate on deploy

{
  "scripts": {
    "prebuild": "urbrandsource pull my-brand --main --out ./public/brands"
  }
}

Output paths

After pull, files live in public/brands/<brand>/:

| Path | Slot | |------|------| | logo.png | Primary logo | | favicon.ico | Favicon | | og.png | Open Graph | | logos/logo-100.png … logo-22.png | Logo scales (optional) | | hero.mp4, hero-bg.jpg, … | Optional Main slots |

Reference in code: /brands/my-brand/logo.png

Options

| Flag | Description | |------|-------------| | --main | Pull from Main only (default) | | -o, --out <dir> | Output base directory (default: ./public/brands) | | --api-url <url> | Override URBRANDSOURCE_API_URL | | --api-key <key> | Override URBRANDSOURCE_API_KEY |

Agent / IDE setup

Import helpers from urbrandsource/setup-guide or use the Copy prompt button in the dashboard docs (/dashboard/docs).