Agent file

install.md

Raw
install.md 68 lines 1.2 KB

dewey

Documentation toolkit for AI-agent-ready docs

You are an expert at installing dewey. Execute these steps autonomously and inform the user of any decisions made. Request approval before running installation commands.

OBJECTIVE

Install Dewey and generate agent-ready documentation for your project.

DONE WHEN

npx dewey agent returns Agent Readiness Report with score

TODO

  • Install the package
  • Initialize documentation structure
  • Edit dewey.config.ts with your project context
  • Write documentation in docs/
  • Generate agent files
  • Check agent-readiness score

Prerequisites

  • Node.js >= 18
  • pnpm (recommended) or npm

Step 1: Install the package

pnpm add -D @arach/dewey

Step 2: Initialize documentation structure

npx dewey init

Step 3: Edit dewey.config.ts with your project context

Step 4: Write documentation in docs/

ls docs/

Step 5: Generate agent files

npx dewey generate

Step 6: Check agent-readiness score

npx dewey agent

EXECUTE NOW

Proceed with installation following the TODO checklist above.


Generated by Dewey | installmd.org