# Kiira

By **alemtuzlak** · Software & Tools

Verifique os tipos do código TypeScript e JavaScript nos seus docs Markdown e MDX em relação à API real do seu projeto, no editor, na CLI e no CI, para que os exemplos documentados nunca fiquem desatualizados ou alucinados.

- Source: https://github.com/AlemTuzlak/kiira
- Repository: https://github.com/AlemTuzlak/kiira
- Install: `npx kiira`
- Tags: cli, open-source, typescript, documentation, dx, ci, vscode, monorepo
- Pricing: free
- Upvotes: 0

## Features

- Verifica os tipos dos blocos de código TS e JS em Markdown e MDX em relação à API real do seu projeto
- Reporta erros inline no seu editor, na CLI e no CI
- Resolução de monorepo com consciência de workspace, sem caminhos tsconfig escritos manualmente
- Sobreposições de compilador por glob para docs com múltiplos frameworks
- Agrupamento de trechos para walkthroughs com múltiplos fences
- Modo de correção automática que reescreve fences com tags erradas e adiciona tags de agrupamento
- Fornecido como biblioteca principal, CLI, extensão VS Code e GitHub Action

---

Kiira extrai os blocos de código TypeScript e JavaScript dos seus documentos Markdown e MDX e verifica os tipos em relação à API real do seu projeto, reportando os erros diretamente na linha de origem, no seu editor, na linha de comando e no CI. Ele existe porque os docs são cada vez mais escritos e atualizados por agentes de IA que alucinam APIs, e o Kiira captura exatamente o que faz um exemplo copiado e colado falhar: imports inválidos, exports ausentes, subcaminhos de pacote incorretos, nomes de funções ou props errados e código que simplesmente não compila.

Ele tem consciência de workspaces em monorepos, mapeando cada pacote para sua origem para que imports internos `@scope/*` sejam resolvidos sem caminhos tsconfig escritos manualmente, suporta sobreposições de compilador por glob para docs com múltiplos frameworks e agrupa trechos que dependem uns dos outros. Um modo `--fix` reescreve fences com tags erradas, adiciona tags de agrupamento e escreve as sobreposições de framework automaticamente. Kiira é fornecido como uma biblioteca principal, uma CLI `kiira`, uma extensão VS Code para squiggles ao vivo dentro dos fences e uma GitHub Action para CI.

## FAQ

### Que problema o Kiira resolve?

Ele mantém os exemplos de código na sua documentação corretos, verificando os tipos em relação à API real do seu projeto, para que imports, exports e nomes de opções não possam ficar desatualizados silenciosamente nem ser alucinados por um agente de IA.

### Onde o Kiira pode ser executado?

No seu editor (uma extensão VS Code exibe squiggles ao vivo dentro dos fences Markdown), na linha de comando via kiira check e no CI por meio da GitHub Action incluída.

### O Kiira funciona em monorepos?

Sim. No modo workspace, ele descobre o workspace do seu pnpm, npm ou yarn e mapeia cada pacote para sua origem, para que docs que importam seus pacotes internos e bibliotecas de terceiros sejam resolvidos sem caminhos tsconfig escritos manualmente.

---
[View on Analog](https://analoghq.ai/pt-br/alemtuzlak/software-tools/kiira)