Monorepo shape
The upstream xtask repository groups runtime packages and sample applications in one workspace so APIs, adapters, decorators, and integrations evolve together.
Documentation
One place for xtaskjs architecture, packages, decorators, integrations, and samples.
Start with the overview, then move into dedicated pages for runtime architecture, package reference, decorator reference, and the official sample applications published in the xtask monorepo.
16 packages documented + 116 decorators + 22 reference samples
Decorator-first design
Controllers, lifecycle hooks, guards, security rules, persistence bindings, and mail delivery are expressed through decorators and resolved at runtime through the kernel and container.
Adapter and integration portability
Business logic stays stable while node-http, Express, Fastify, TypeORM, security, and mailer integrations change how the app is delivered and extended.
Quick Start
Boot the smallest useful xtask application
Install
npm install @xtaskjs/core @xtaskjs/common reflect-metadataBootstrap
import "reflect-metadata";
import { CreateApplication } from "@xtaskjs/core";
await CreateApplication({
adapter: "node-http",
autoListen: true,
server: { host: "127.0.0.1", port: 3000 },
});Sections
Move through the documentation by topic
Documentation
Architecture
Boot lifecycle, request pipeline, and security flow diagrams.
Open ArchitectureDocumentation
Packages
Detailed reference for core, common, adapters, TypeORM, security, mailer, internationalization, scheduler, cache, queues, and value objects.
Open PackagesDocumentation
CLI
Console client installation, command reference, and generation workflow.
Open CLIDocumentation
Decorators
Decorator catalog organized by type and package, with examples.
Open DecoratorsDocumentation
Samples
Official sample applications and how to use them.
Open SamplesHighlights
What this documentation focuses on
Monorepo shape
The upstream xtask repository groups runtime packages and sample applications in one workspace so APIs, adapters, decorators, and integrations evolve together.
Decorator-first design
Controllers, lifecycle hooks, guards, security rules, persistence bindings, and mail delivery are expressed through decorators and resolved at runtime through the kernel and container.
Adapter and integration portability
Business logic stays stable while node-http, Express, Fastify, TypeORM, security, and mailer integrations change how the app is delivered and extended.