[data-reveal]{opacity:1!important;transform:none!important}
AntelopeJS DMS
DocumentationInstallation

Installation

Add the assistant to a DMS project, give it an agent, and open the chat.

Add the module

Terminal bash
ajs project modules add @antelopejs/dms-assistant

The module ships its sidecar and the routes that connect a database, and depends on the Claude Code agent, so all of them install with it. It starts the sidecar with the project as its working directory.

The README compatibility table lists the supported @antelopejs/interface-dms range. The @antelopejs/dms-frontend renderer must be in the range that engines["@antelopejs/dms-frontend"] of frontend-vue/package.json declares.

Point the sidecar at the backend

Reference the origin that the api module reserved, so you do not repeat a port:

antelope.config.ts ts
"dms-assistant": {
  source: { type: "package", package: "@antelopejs/dms-assistant" },
  config: {
    backendUrl: "${@api.API_LOCAL_BASE_URL}",
  },
},

Give Safe mode its tools

Safe mode is the default scope. In it, the agent makes typechecked page, table and query edits through the builder tools of the DMS MCP server, without raw file writes. The DMS serves that server in development. Set mcp.backendUrl in the dms module's config to ${@api.API_LOCAL_BASE_URL}, as Where the chat's tools come from explains.

Sign the agent in

Claude Code runs on this machine with its own credentials, either its login or ANTHROPIC_API_KEY in the backend's environment. To use Codex instead, see Enable Codex.

Start development mode and open the chat

From your project directory, run the backend with ajs project dev and the frontend with ajs dms dev, in separate terminals. Sign in as an owner. Then press Ctrl Shift K (⌘ ⇧ K on macOS), or click the sparkle icon in the header.

Only the development frontend shows the chat launcher. A production frontend build does not show it, and with NODE_ENV=production the backend starts no sidecar.

Stop or skip the sidecar

  • To run the backend without the sidecar, set DMS_ASSISTANT=0 before you start it.
  • To stop the sidecar, stop the project. Ctrl C reaches the sidecar through the terminal's process group. On Linux, the AntelopeJS core also terminates it on shutdown.
  • A hot reload of the module keeps the sidecar running, unless the sidecar's build changed.
  • If a backend crashed and left its sidecar running, the next run stops that sidecar when it starts. A sidecar also exits after 15 idle minutes. The next dashboard probe starts it again.