pull

Overview

The pull command generates or updates your TypeScript schema from Notion databases.

npx notcms-kit pull

What it does

Fetches database structure and properties
Generates TypeScript types
Updates your schema file

Options

Option	Description	Default
`--env`	Environment file path	`[".env", ".env.local", ".dev.vars"]`

Examples

Basic pull

npx notcms-kit pull

Specify environment file path

npx notcms-kit pull --env .env.development

Generated Schema

The command generates a fully typed schema:

import { Schema } from 'notcms';

export const schema = {
  // example
  blog: {
    id: "abc123...",
    properties: {
      title: "title",
      content: "rich_text",
      published: "checkbox",
      publishDate: "date",
      author: "relation",
      tags: "multi_select"
    }
  }
} satisfies Schema;

Schema Updates

When you update Notion databases, the pull command will update your schema.

{
  "scripts": {
    "schema:pull": "notcms-kit pull",
  }
}

Getting Started

Usage

CLI Commands

Examples

Overview

What it does

Options

Examples

Basic pull

Specify environment file path

Generated Schema

Schema Updates

​Overview

​What it does

​Options

​Examples

​Basic pull

​Specify environment file path

​Generated Schema

​Schema Updates

Overview

What it does

Options

Examples

Basic pull

Specify environment file path

Generated Schema

Schema Updates