@airdraft/cli

Command-line interface for Airdraft. Scaffolds projects, generates TypeScript types from your schema, validates configuration, and authenticates with Airdraft Cloud.

Installation

npm install -g @airdraft/cli
# or run directly
npx airdraft <command>

Commands

airdraft init

Interactive project setup. Creates airdraft.config.ts, .env.local, and the Next.js API route handler.

npx airdraft init
npx airdraft init --force   # overwrite existing files

Modes:

• local — local filesystem adapter (LocalAdapter); no GitHub required
• cloud-app — Mode 2: Airdraft Cloud GitHub App (project key from dashboard)
• own-app-auto — Mode 3: register your own GitHub App via browser flow
• own-app-manual — Mode 3: enter GitHub App credentials manually

The wizard also prompts for optional plugins (auth, media, seo, audit-log, schema-editor) and optionally scaffolds blog pages using @airdraft/react-content.

airdraft generate-types

Reads your schema and writes strongly-typed TypeScript interfaces to lib/cms-types.ts.

npx airdraft generate-types
npx airdraft generate-types --source ./airdraft.schema.json --out lib/cms-types.ts
npx airdraft generate-types --source https://your-project.airdraft.cloud/api/cms/schema --api-key <key>

Options:

| Flag | Default | Description | |---|---|---| | --source | ./airdraft.schema.json | Local file path or HTTP(S) URL | | --out | ./lib/cms-types.ts | Output file path | | --api-key | — | Sent as x-api-key when fetching from a URL |

Generated output per collection:

• A {Collection}Data interface with all fields typed
• {Field}_url?: string and {Field}_media?: { key, url?, name?, mimeType?, size? } companion fields for image and single media fields
• {Field}_urls?: string[] and {Field}_medias?: Array<{...}> for media fields with multiple: true
• Named {Collection}{Field}Block / {Collection}{Field}BlockItem interfaces for blocks fields, with sub-fields typed inline
• A {Collection}Entry wrapper interface ({ slug, meta, data })
• AnyEntry union and CollectionName literal type

airdraft validate

Validates your airdraft.config.ts (or airdraft.config.json) and schema against the Airdraft spec.

npx airdraft validate
npx airdraft validate --config ./airdraft.config.ts

airdraft generate-secret

Prints a cryptographically random 32-byte hex string. Use it to set AIRDRAFT_REVALIDATE_SECRET.

npx airdraft generate-secret

airdraft login

Authenticates with Airdraft Cloud and stores a CLI token locally.

npx airdraft login

Programmatic API

All commands are also importable for use in scripts and tests:

import { initProject, generateTypes, validateConfig, generateSecret } from '@airdraft/cli'

| Export | Description | |---|---| | initProject(opts) | Runs the full init flow; accepts InitOptions for non-interactive use | | generateTypes(opts) | Generates TypeScript types from a schema source | | validateConfig(opts) | Validates config + schema; returns { valid, errors } | | printSchema(schema) | Formats a CmsSchema as a human-readable string | | generateSecret() | Returns a random hex string |

Changelog

See CHANGELOG.md.