Scaffold a service

connectum init creates a runnable project with a sample service, health checks and reflection. The generated files are your application: edit its contract, write handlers and configure the capabilities you select.

npx @connectum/cli init my-service --yes
cd my-service
pnpm install
pnpm start

Run init without --yes to choose runtime, package manager and modules interactively. The default project uses pnpm and direct Node.js TypeScript execution; check runtime requirements. The CLI fetches its pinned example base from GitHub, so the first run needs network access.

Use Builder to inspect the selected project before downloading it, or follow Quickstart to add a protected Page RPC.

The scaffold structure and CLI guide in Build a service explains generated files, module composition, command options, service generation and proto synchronization. The manual tutorial builds the foundation without init.

Find a section from the full guide

The detailed material is preserved on a separate page. Earlier section links still work here.

• connectum init
• Optional modules: auth, events, and telemetry
• Options
• Project path and name
• --no-sample: a config-only project
• What --auth generates
• Lint rules in buf.yaml
• Connectum option protos
• Enums in generated code
• Interceptor order
• Dependency build scripts under pnpm
• connectum generate service
• Service names
• connectum proto sync
• Adding a service by hand