docasur

Configuration-driven site exploration and documentation planning tool.

Docasur crawls your web application, identifies user flows, and generates structured documentation — all driven by a single config file.

Install

npm install -g docasur

Or use without installing:

npx docasur --help

Quickstart

# 1. Create a configuration file
docasur init

# 2. Edit docasur.config.ts to match your site

# 3. Run the full pipeline
docasur run

# Or run stages individually
docasur crawl
docasur plan
docasur generate

docasur --help

Usage: docasur [options] [command]

Configuration-driven site exploration and documentation planning tool

Options:
  -V, --version   output the version number
  -h, --help      display help for command

Commands:
  init            Initialize a docasur configuration file in the current directory
  crawl           Crawl the configured site and capture page data
  plan            Generate a documentation plan from crawl results
  generate        Generate documentation from the plan
  run             Run the full pipeline: crawl → plan → generate
  help [command]  display help for command

Configuration

Create a docasur.config.ts at your project root:

import { defineConfig } from 'docasur'

export default defineConfig({
  site: {
    baseUrl: 'http://localhost:3000',
    paths: [
      { path: '/auth/login', tags: ['auth'], priority: 10 },
      { path: '/dashboard', tags: ['core'], priority: 8 },
    ],
    ignorePaths: [
      { type: 'glob', value: '/admin/**' },
    ],
  },
  traversal: {
    maxDepth: 3,
    maxPages: 50,
  },
  output: {
    format: 'markdown',
    outputDir: 'docs/site',
    filenameStrategy: 'path-based',
    overwriteExisting: false,
  },
})

License

MIT