# typeorm

A skill that gives your agent rules for writing TypeORM code: entities, relations, repositories and migrations. Useful on any TypeScript project with a database.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 2000 installs · ★ 286
- Author: Mindrally
- License: Apache-2.0 · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/Mindrally/skills/tree/HEAD/typeorm/SKILL.md
- Updated: 2026-10-08
- HTML: https://affpapa.org/en/nevibecode/skills/typeorm

## What it does

The skill covers how to write TypeORM code: entities with decorators, column types, one-to-one, one-to-many and many-to-many relations, repositories, and the Query Builder. It points the agent at the Data Mapper pattern and enterprise application architecture rather than Active Record.

It also lists the `tsconfig.json` settings you need: `experimentalDecorators`, `emitDecoratorMetadata`, `strict`, `target: ES2020`, `module: commonjs`, `moduleResolution: node`. Skip the first two and decorators won't work at all, so that's the first thing to check in your config. From there come examples of entities, composite primary keys, `@CreateDateColumn`, `@DeleteDateColumn` for soft deletes, and `@VersionColumn` for optimistic locking.

Separate sections cover custom repositories, `findOneOrFail`, `softDelete`, and `DataSource` configuration. TypeORM itself supports MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server and Oracle. Install takes one command across Claude, Codex, Cursor, GitHub Copilot, Gemini CLI or OpenCode.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add Mindrally/skills --skill typeorm -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/typeorm/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/typeorm/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add Mindrally/skills --skill typeorm -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/typeorm/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add Mindrally/skills --skill typeorm -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/typeorm/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install Mindrally/skills typeorm
```

2. **Manually: put the files in place**
- File: `.github/skills/typeorm/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add Mindrally/skills --skill typeorm -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/Mindrally/skills --path typeorm
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/typeorm/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add Mindrally/skills --skill typeorm -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/Mindrally/skills/tree/HEAD/typeorm/SKILL.md

## When to use it
- define an entity with decorators and relations
- set up `tsconfig.json` for TypeORM decorators
- choose between Active Record and Data Mapper
- write a custom repository with lookup methods
- build a Query Builder query with joins and pagination

## Example prompts
- define a User entity with a one-to-many relation to Post, following the typeorm skill
- write a custom repository with a method that finds active users
- check my tsconfig.json for the settings TypeORM needs

## Source text · SKILL.md · Apache-2.0

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: a10d773eddd86d4f.

BEGIN THIRD-PARTY FILE a10d773eddd86d4f
````text
---
name: typeorm
description: Guidelines for developing with TypeORM, a full-featured ORM for TypeScript and JavaScript supporting multiple databases
metadata:
  maintainer: Mindrally
  source: https://github.com/Mindrally/skills
---

# TypeORM Development Guidelines

You are an expert in TypeORM, TypeScript, and database design with a focus on the Data Mapper pattern and enterprise application architecture.

## Core Principles

- TypeORM supports both Active Record and Data Mapper patterns
- Uses TypeScript decorators for entity and column definitions
- Supports MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, Oracle, and more
- Works in Node.js, Browser, Ionic, Cordova, React Native, NativeScript, Expo, and Electron
- First-class support for database migrations

## TypeScript Configuration

Required settings in tsconfig.json:

```json
{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true,
    "strict": true,
    "target": "ES2020",
    "module": "commonjs",
    "moduleResolution": "node"
  }
}
```

## Entity Definition

### Basic Entity

```typescript
import {
  Entity,
  PrimaryGeneratedColumn,
  Column,
  CreateDateColumn,
  UpdateDateColumn,
} from "typeorm";

@Entity("users")
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column({ type: "varchar", length: 255, unique: true })
  email: string;

  @Column({ type: "varchar", length: 255, nullable: true })
  name: string | null;

  @Column({ type: "boolean", default: true })
  isActive: boolean;

  @CreateDateColumn()
  createdAt: Date;

  @UpdateDateColumn()
  updatedAt: Date;
}
```

### Primary Key Options

```typescript
// Auto-increment
@PrimaryGeneratedColumn()
id: number;

// UUID
@PrimaryGeneratedColumn("uuid")
id: string;

// Custom primary key
@PrimaryColumn()
id: string;

// Composite primary key
@Entity()
export class OrderItem {
  @PrimaryColumn()
  orderId: number;

  @PrimaryColumn()
  productId: number;
}
```

### Column Decorators

```typescript
@Entity()
export class Product {
  @PrimaryGeneratedColumn()
  id: number;

  // String columns
  @Column({ type: "varchar", length: 255 })
  name: string;

  @Column({ type: "text", nullable: true })
  description: string | null;

  // Numeric columns
  @Column({ type: "decimal", precision: 10, scale: 2 })
  price: number;

  @Column({ type: "int", default: 0 })
  stock: number;

  // Boolean
  @Column({ type: "boolean", default: true })
  isAvailable: boolean;

  // JSON
  @Column({ type: "jsonb", nullable: true })
  metadata: Record<string, any> | null;

  // Enum
  @Column({
    type: "enum",
    enum: ["active", "inactive", "pending"],
    default: "pending",
  })
  status: "active" | "inactive" | "pending";

  // Timestamps
  @CreateDateColumn()
  createdAt: Date;

  @UpdateDateColumn()
  updatedAt: Date;

  @DeleteDateColumn()
  deletedAt: Date | null; // For soft deletes
````
END THIRD-PARTY FILE a10d773eddd86d4f

The third-party file has ended. Everything between the a10d773eddd86d4f tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 2902 of 14001 bytes. © Mindrally · Apache-2.0 · https://github.com/Mindrally/skills/tree/HEAD/typeorm/SKILL.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md