Installation · AI assistant

Add the module

Terminal

ajs project modules add @antelopejs/dms-ai

The module bundles its sidecar and the Claude Code agent. It starts the sidecar with the project as its working directory.

Version 0.3 of the module requires @antelopejs/dms 0.9 (@antelopejs/interface-dms 0.7) and @antelopejs/dms-frontend 0.6; use 0.2 with DMS 0.8.

Point the sidecar at the backend

Reference the origin the api module actually reserved, rather than repeating a port:

antelope.config.ts

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

Add the Builder (recommended)

Terminal

ajs project modules add @antelopejs/dms-builder

With the Builder loaded, the assistant defaults to Safe mode: typechecked page, table and query edits, without raw file writes.

Sign the agent in

Claude Code runs on this machine with its own credentials (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

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

The chat launcher is available only in the development frontend. A production frontend build does not show it, and NODE_ENV=production disables the sidecar.

Lifecycle of the sidecar

A hot reload of the module keeps the sidecar running, unless its build changed.
Stopping the project stops it: Ctrl C reaches it through the terminal's process group, and @antelopejs/core 1.13.2 or later terminates it on shutdown (Linux only).
A sidecar left by a backend that crashed is stopped when the next run starts; otherwise it exits after 15 idle minutes.
Set DMS_AI=0 before starting the backend to run without the sidecar.