Kiira
ChevronDown
Github

The config file

How to create a Kiira config file with defineConfig from kiira-core, the supported file variants, and how Kiira discovers your config.

Creating a config

Kiira is configured with a kiira.config.ts file at the root of your project, built with defineConfig from kiira-core:

import { defineConfig } from "kiira-core"
export default defineConfig({
include: ["docs/**/*.md", "docs/**/*.mdx", "README.md"],
})

defineConfig is an identity helper that gives you full type-safety and autocomplete on every option — it returns the config object unchanged.

Supported file variants

Kiira auto-discovers a config file with any of these extensions:

  • kiira.config.ts
  • kiira.config.mts
  • kiira.config.mjs
  • kiira.config.js
  • kiira.config.cjs
  • kiira.config.json

The CLI loads TypeScript configs for you. If you call loadConfig from kiira-core yourself, install jiti to load a .ts config. Without it, Kiira imports the file natively, which works for .mjs, .js, and .cjs configs, and for .ts configs on a Node version that strips types.

You can also point at a specific file with --config:

kiira check --config configs/kiira.config.mts

Every option has a sensible default. include defaults to every .md and .mdx file — see the Options reference.