npx skills add ...
npx skills add encoredev/skills --skill encore-service
npx skills add encoredev/skills --skill encore-service
Plan how to split an Encore.ts application into services and lay out its directory structure. Architecture and decomposition, not first-time CLI install (that's `encore-getting-started`).
Every Encore service needs an encore.service.ts file:
Best for new projects - start simple, split later if needed:
For distributed systems with clear domain boundaries:
Group related services into systems:
Import other services from ~encore/clients:
Split when you have:
| Signal | Action |
|---|---|
| Different scaling needs | Split (e.g., auth vs analytics) |
| Different deployment cycles | Split |
| Clear domain boundaries | Split |
| Shared database tables | Keep together |
| Tightly coupled logic | Keep together |
| Just organizing code | Use folders, not services |
Control which endpoints middleware applies to:
The request object provides access to:
~encore/clients for cross-service calls (never direct imports)my-app/
├── encore.app
├── package.json
├── user/
│ ├── encore.service.ts
│ ├── api.ts
│ └── db.ts
├── order/
│ ├── encore.service.ts
│ ├── api.ts
│ └── db.ts
└── notification/
├── encore.service.ts
└── api.tsmy-app/
├── encore.app
├── commerce/
│ ├── order/
│ │ └── encore.service.ts
│ ├── cart/
│ │ └── encore.service.ts
│ └── payment/
│ └── encore.service.ts
├── identity/
│ ├── user/
│ │ └── encore.service.ts
│ └── auth/
│ └── encore.service.ts
└── comms/
├── email/
│ └── encore.service.ts
└── push/
└── encore.service.tsimport { user } from "~encore/clients";
export const getOrderWithUser = api(
{ method: "GET", path: "/orders/:id", expose: true },
async ({ id }): Promise<OrderWithUser> => {
const order = await getOrder(id);
const orderUser = await user.get({ id: order.userId });
return { ...order, user: orderUser };
}
);import { Service } from "encore.dev/service";
import { middleware } from "encore.dev/api";
const loggingMiddleware = middleware(
{ target: { all: true } },
async (req, next) => {
console.log(`Request: ${req.requestMeta?.path}`);
return next(req);
}
);
export default new Service("my-service", {
middlewares: [loggingMiddleware],
});// Apply to all endpoints
middleware({ target: { all: true } }, handler);
// Apply only to authenticated endpoints
middleware({ target: { auth: true } }, handler);
// Apply only to exposed (public) endpoints
middleware({ target: { expose: true } }, handler);
// Apply to raw endpoints only
middleware({ target: { isRaw: true } }, handler);
// Apply to streaming endpoints only
middleware({ target: { isStream: true } }, handler);
// Apply to endpoints with specific tags
middleware({ target: { tags: ["admin", "internal"] } }, handler);const myMiddleware = middleware(
{ target: { all: true } },
async (req, next) => {
// For typed and streaming APIs
const meta = req.requestMeta; // { method, path, pathParams }
// For raw endpoints
const rawReq = req.rawRequest;
const rawRes = req.rawResponse;
// For streaming endpoints
const stream = req.stream;
// Custom data to pass to handlers
req.data = { startTime: Date.now() };
const resp = await next(req);
// Modify response headers
resp.header.set("X-Response-Time", `${Date.now() - req.data.startTime}ms`);
return resp;
}
);