# kiira
**The Kiira command line — type-check the code in your Markdown.**
[](https://www.npmjs.com/package/kiira)
[](https://github.com/AlemTuzlak/kiira/blob/main/LICENSE)
---
`kiira` installs the `kiira` binary. It extracts the TypeScript and JavaScript
code fences from your Markdown, type-checks them against your **real project API** — the same
`tsconfig`, the same workspace packages, the same dependency types — and reports any errors
back on the exact Markdown line, locally and in CI.
> Looking for live squiggles while you write? Install the **Kiira** VS Code extension
> ([Marketplace](https://marketplace.visualstudio.com/items?itemName=CodeForge.kiira-vscode)).
> Full documentation lives in [`/docs`](https://github.com/AlemTuzlak/kiira/tree/main/docs).
## Why
Docs are increasingly written and updated by agents, and agents hallucinate APIs. Kiira
catches the things that make a copy-pasted example fail:
- invalid imports and missing exports
- wrong package subpaths
- wrong function, option, or prop names
- invalid TypeScript / JavaScript (with `checkJs`)
- non-copy-pasteable examples — unless explicitly marked partial or ignored
## Install
```bash
pnpm add -D kiira # npm i -D / yarn add -D / bun add -d
```
The package ships the `kiira` bin, so `pnpm kiira …` (or `npx kiira …`) just works.
## Quick start
Scaffold a config and a docs `tsconfig`, then run a check:
```bash
kiira init # writes kiira.config.ts + tsconfig.docs.json (skips existing files)
kiira check # validate everything in your include globs
```
### How it works
For every Markdown file Kiira:
1. **Extracts** each ` ```ts ` / ` ```tsx ` / ` ```js ` / ` ```jsx ` fence and parses its
info string for metadata (`validate=`, `fixture=`, `group=`, …).
2. **Builds an in-memory virtual file** per snippet (nothing is written to disk), applying
any fixtures and, for `group=` snippets, concatenating them in document order so a later
fence can use a `const` declared in an earlier one.
3. **Type-checks** the virtual files with a TypeScript program seeded from your `tsconfig` and
your workspace's module resolution.
4. **Maps diagnostics** from the virtual file back to the precise line and column inside the
Markdown fence and prints them with your chosen reporter.
## Fence format
````md
```ts
import { createAgent } from "@tanstack/ai"
```
````
Add metadata after the language to control validation:
````md
```tsx fixture=react validate=type name=basic-chat
import { useChat } from "@tanstack/ai/react"
export function Chat() {
const chat = useChat()
return
