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.
21 packages documented + 114 decorators + 25 reference samples
Ecosystem repositories
The xtaskjs domain currently coordinates four public repositories: xtask (runtime + samples), xtask-cli (console tooling), typescript-starter (project template), and xtaskjs.io (documentation website).
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 },
});CLI Flow
From scaffold to operations with xtask-cli
Use this sequence to create a project, generate artifacts, install runtime modules, and inspect cache behavior from the CLI.
Scaffold
1. Create project
Scaffold a new app from the official starter with your preferred package manager.
xtask create my-api --package-manager pnpmCodegen
2. Generate feature
Create a CRUD-ready resource with DTO support to start from a production-oriented baseline.
xtask generate resource users --path src/modules --crud --with-dtoModules
3. Add modules
Install official runtime modules, including security, cache, MCP, and bots support.
xtask add security cache mcp botsOps
4. Inspect cache
Query one route's effective HTTP cache policy from the running application.
xtask cache http-route --method GET --path /usersSections
Move through the documentation by topic
Documentation
Architecture
Boot lifecycle, request pipeline, and security flow diagrams.
Open ArchitectureDocumentation
Packages
Detailed reference for core, common, config, validation, testing, adapters, TypeORM, security, mailer, internationalization, scheduler, cache, queues, value objects, socket-io, throttler, and bots.
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 Samples
Highlights
What this documentation focuses on
Highlights
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.
Ecosystem repositories
The xtaskjs domain currently coordinates four public repositories: xtask (runtime + samples), xtask-cli (console tooling), typescript-starter (project template), and xtaskjs.io (documentation website).
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.