documentation

Run it in one command.

Everything works with zero configuration. Node.js 22+ is the only requirement.

Quick start

# clone and start
git clone https://github.com/itsmaxjeffrey/businex.git
cd businex
npm install
npm run dev

# web desktop → http://localhost:5199
# API          → http://127.0.0.1:8788/api/health

Register on first launch and you get a clean workspace with the full module map — no sample data, no external accounts.

Configuration

VariableDefaultPurpose
BUSINEX_HOST127.0.0.1API bind address
BUSINEX_PORT8788API port
BUSINEX_WEB_ORIGINhttp://localhost:5199Allowed web origin
BUSINEX_DATA_DIRapps/server/dataDatabase, secrets, uploads

OpenClaw integration

Connect a gateway in Settings → Agents, then run sessions, send messages and list automations from the workspace. Agents can operate Businex records through scoped API keys — install the bundled skill:

# in your OpenClaw agent workspace
cp integrations/openclaw/SKILL.md ~/.agents/skills/businex/SKILL.md

# the skill drives the REST API with a scoped key
Authorization: ***bnx_…

open-tag collaboration

Channels, threads, mentions and shared tasks follow the open-tag model natively. Bridge agent execution to an open-tag daemon to run Claude Code, Codex, Copilot or OpenClaw runtimes as teammates — replies land back in the originating thread.

user: @ops-bot where does the Acme rollout stand?
agent: proposal stage (48k) · 2 tasks open · sign-off Friday

MCP server

Any MCP-capable runtime can use Businex as a toolset:

POST /api/mcp   # JSON-RPC 2.0

tools: businex.search · businex.contact.create · businex.task.create
       businex.document.write · businex.invoice.create
       businex.channel.post · businex.analytics.overview

Development

npm run dev      # server + web together
npm run build    # typecheck + production build
npm test         # unit tests (server + web)
npm run smoke    # end-to-end smoke test: 24 checks