Getting Started

Installation

Install the package using your preferred package manager:

npm install -D @arach/dewey

Or with pnpm:

pnpm add -D @arach/dewey

Quick Setup

Initialize your documentation structure:

npx dewey init

# This creates docs/ and dewey.config.ts
# Edit the config with your project context:

import { defineConfig } from '@arach/dewey'

export default defineConfig({
  name: 'my-project',
  docs: './docs',
})

Note: Never expose your API key in client-side code. Use environment variables or a server-side proxy.

Core Concepts

Dewey is built around three key ideas:

1. Agent Content Pattern — Each page has human (.md) and agent (.agent.md) versions
2. Skills System — LLM prompts that guide AI agents through specific tasks
3. install.md Standard — LLM-executable install instructions following installmd.org

CLI Commands

Dewey provides these commands:

Command	Description
dewey init	Create docs/ folder and config
dewey audit	Check documentation completeness
dewey generate	Create agent-ready files
dewey agent	Score agent-readiness (0-100)

Agent Readiness

Check how well your docs serve AI agents:

npx dewey agent

# Agent Readiness Report
# Score: 82/100
#
# ✓ AGENTS.md found
# ✓ llms.txt found
# ✓ install.md found
# ✗ Missing .agent.md variants for 3 pages

What's Next

• Read the Configuration guide for advanced setup
• Explore the built-in skills for docs review and improvement
• Check the components library for building doc sites

---

Built with care by the Dewey team.