webcrm-ucs

ucs (Unified Content Sync) connects an existing static website to the WebCrm platform. It verifies your domain, crawls or scans your site, imports its content into WebCrm, and keeps your static site in sync with the live WebCrm content.

Install

npm install -g webcrm-ucs
# or run without installing:
npx webcrm-ucs --help

Requires Node.js 18+.

By default ucs talks to the hosted WebCrm backend; set WCRM_API_URL or use --api-url to point it at another instance (e.g. your local dev server).

Quick start

ucs setup --domain example.org --source https://example.org

setup runs the full flow interactively:

1. Verify — claims your domain against your organization and prints the verification instructions (META tag, DNS TXT, or file).
2. Analyze — crawls a live URL (--source https://…) or scans a local folder (--source ./public) and builds webcrm-import.json.
3. Import — pushes pages, menus, media, teams, testimonials and more into WebCrm (merge or replace mode).

On successful verification WebCrm issues a site API key for your domain. ucs stores it and uses it for subsequent import/pull calls, so you don't need an admin session each time. Manage keys in the admin panel under Website → Site Sync (UCS).

Then run ucs pull after edits in WebCrm to refresh webcrm.json, which your static site renders.

Commands

| Command | Description | | ---------------------- | -------------------------------------------------------- | | ucs setup | Guided setup: verify domain, analyze, import. | | ucs status | Show connection and domain verification status. | | ucs analyze <source> | Crawl a URL or scan a folder into webcrm-import.json. | | ucs import [file] | Import a webcrm-import.json into WebCrm. | | ucs pull | Fetch live WebCrm site data into webcrm.json. |

Every command accepts --api-url <url> to override the backend. Run ucs <command> --help for full options.

Configuration

ucs stores its connection details in .webcrm/config.json inside your project root. It also writes webcrm-import.json (analyzer output) and webcrm.json (pull output). Add .webcrm/ to your .gitignore.

Environment

| Variable | Default | Used by | | --------------- | ----------------------------------- | ------------- | | WCRM_API_URL | https://web-crm-green.vercel.app/api/v1 | All commands |

Non-interactive (CI) setup

ucs setup --yes \
  --org my-org \
  --email [email protected] \
  --password '…' \
  --domain example.org \
  --source https://example.org \
  --no-import

Development

npm install
npm run build
node dist/index.js --help

License

MIT