create-drobek-module

Scaffold a drobek platform module:

npm create drobek-module@latest erp
# → drobek-module-erp/ — the module "erp"
npm create drobek-module@latest @acme/drobek-module-erp
npm create drobek-module@latest acme-erp -- --module acmeerp

Options: --module <name> (the module name, ^[a-z][a-z0-9]{1,30}$; default: the package name without drobek-module- and dashes), --dir <parent>, --force (write into a non-empty directory).

The output is a working module against the module contract ^1.1:

• src/index.ts — defineModule with contract, config + an owner confirmation, a secret, a limit, an own error code and a GET/POST route pair over the module's table;
• src/sdk.ts — the browser half (drobek.<name>.list() / add(title));
• src/schema.ts + migrations/0000_init.sql — the table mod_<name>_items;
• SKILL.md — the five-section skill an agent reads with skill_info;
• src/index.test.ts — the routes through the production pipeline (createModuleTestContext) over PGlite with the drobek core migrations;
• src/skill.test.ts — checkSkill, the SKILL.md gate of the built-in modules (npm run check);
• README.md — building, publishing and installing it on a server (task selfhost:module:add).

The generated package.json installs the contract from npm under the name the code imports — "@drobek/modules": "npm:@freema/drobek-modules@^X.Y.Z" in devDependencies — and declares the peer "@drobek/modules": ">=X.Y.Z" the server's installer checks.

A module can also extend another one through its slots instead of (or besides) serving an app: a sign-in method contributes to auth.provider, an e-mail provider for the whole server (SES, Postmark, a company relay) contributes defineEmailTransport({ id, label, secrets, send }) to email.transport and is chosen with EMAIL_TRANSPORT=<id> — see E-mail transports from modules; a place for the server's errors (an incident webhook, a log service) contributes defineErrorReporter({ id, label, secrets, report }) to the core-hosted errors.reporter slot and is chosen with ERROR_REPORTER=<id> — see Error reporters from modules. A module that does nothing but that serves only the server: it may drop skill, routes and the SDK, keep configSchema: z.object({}), and agents and app owners never see it — Operator-only modules.

The guide is Writing a module. Licence: AGPL-3.0-only.