Getting Started

Installation

Install Dewey using your preferred package manager. Requires Node.js 18 or later.

The package includes TypeScript definitions out of the box — no need to install separate @types packages.

# npm
npm install -D @arach/dewey

# pnpm
pnpm add -D @arach/dewey

# yarn
yarn add -D @arach/dewey

Quick Setup

Initialize your docs structure with dewey init. This creates the docs folder and config file.

Edit dewey.config.ts with your project context to customize output generation.

import { defineConfig } from '@arach/dewey'

export default defineConfig({
  name: 'my-project',
  docs: './docs',
  output: {
    agentsMd: true,
    llmsTxt: true,
    installMd: true,
  },
})

Generating Files

Generate agent-ready output files from your documentation. Dewey creates AGENTS.md, llms.txt, docs.json, and install.md.

Use --agents-md, --llms-txt, or --install-md flags to generate specific files only.

# Generate all agent-ready files
npx dewey generate

# Generate specific files
npx dewey generate --agents-md
npx dewey generate --llms-txt
npx dewey generate --install-md

Auditing Docs

Audit your documentation for completeness and agent-readiness. The audit checks for missing sections, broken links, and structural issues.

Use --json for machine-readable output or --verbose for detailed results.

# Run audit
npx dewey audit --verbose

# Output as JSON
npx dewey audit --json

Agent Readiness Score

Score your documentation's agent-readiness from 0 to 100. The score measures how well your docs can be consumed by AI agents and LLMs.

Use --fix to auto-create missing files and folders.

# Check score
npx dewey agent

# Auto-fix missing files
npx dewey agent --fix