Installation

Requirements

• Node.js 18 or later
• A Contentful space with a management token

Packages

ctkit is split into two packages:

Package	Purpose
@ctkit/cli	The CLI tool — run commands like ctkit push, ctkit generate, ctkit migrate
@ctkit/core	Types, constants, and validators — import these in your schema files

Installing @ctkit/cli automatically installs @ctkit/core as a dependency, so a single install gives you everything.

Install ctkit

You can install ctkit as a project dependency (recommended) or globally.

Project dependency

npm

npm install @ctkit/cli

pnpm

pnpm add @ctkit/cli

yarn

yarn add @ctkit/cli

Then run it with npx ctkit, pnpm ctkit, or yarn ctkit.

Global install

npm

npm install -g @ctkit/cli

pnpm

pnpm add -g @ctkit/cli

yarn

yarn global add @ctkit/cli

Verify installation

ctkit --version

You should see the installed version printed to stdout. If you installed locally, use npx ctkit --version.

Importing in schemas

Schema files import types, constants, and validators from @ctkit/core:

import { ContentTypeSchema, FieldType, validators } from '@ctkit/core';