autowiki 1.2.1 → 1.2.3

package/README.md

@@ -1,183 +1,95 @@
-![Agent Wiki](static/agent-wiki.png)
+<p align="center">
+  <img src="static/agent-wiki.png" alt="autowiki" width="400">
+</p>
 
-A Claude Code plugin that maintains an auto-updating wiki for agent context about how repository components work.
+<h1 align="center">autowiki</h1>
 
-## Features
+<p align="center">
+  Auto-generated wiki documentation for your codebase, built by AI agents and browsable by humans.
+  <br><br>
+  <a href="https://www.npmjs.com/package/autowiki"><img src="https://img.shields.io/npm/v/autowiki" alt="npm version"></a>
+</p>
 
-- **`/agent-wiki:init`** - Initialize a new wiki by exploring the codebase with parallel sub-agents
-- **`/agent-wiki:update`** - Update the wiki to reflect recent code changes
-- **`/agent-wiki:reorganize`** - Analyze and restructure the wiki if needed
-- **`/agent-wiki:serve`** - Start a local web server to browse the wiki
+---
 
-## Installation
+## How It Works
 
-```bash
-# In Claude Code, add the GitHub repo as a marketplace
-/plugin marketplace add github:anyweez/agent-wiki
+**autowiki** has two parts that work together:
 
-# Install the plugin
-/plugin install agent-wiki@anyweez/agent-wiki
-```
+1. **A Claude Code plugin** that builds and maintains a wiki for your repo. Run `/autowiki:init` and Claude explores your codebase, identifies key concepts, and writes structured markdown documentation in a `wiki/` directory. The wiki updates incrementally as your code changes — no need to regenerate from scratch.
 
-### Install for local development
+2. **An npm package** (`npx autowiki`) that serves the wiki as a polished, searchable website. Dark mode, sidebar navigation, full-text search, wikilinks between pages — all running locally with zero configuration.
 
-If you want to develop or modify the plugin locally:
+The generated wiki is immediately useful for AI agents as raw markdown (plus `llms.txt`), and just as useful for humans via the web UI.
 
-```bash
-# Clone this repository
-git clone https://github.com/anyweez/agent-wiki.git
-cd agent-wiki && npm install
+## Getting Started
 
-# Option A: Run Claude Code with the plugin loaded directly
-claude --plugin-dir /path/to/agent-wiki
+### Install the Claude Code plugin
 
-# Option B: Add as a local marketplace for installation management
-/plugin marketplace add /path/to/agent-wiki
-/plugin install agent-wiki@agent-wiki-marketplace
+```bash
+/install-plugin github:anyweez/autowiki
 ```
 
-## Usage
+### Generate your wiki
 
-Commands are namespaced with `agent-wiki:` prefix when installed as a plugin.
+```
+/autowiki:init
+```
 
-### Initialize a wiki
+Claude will explore your codebase and create a `wiki/` directory with structured documentation.
 
-In any repository:
+### Browse it
 
-```
-/agent-wiki:init
+```bash
+npx autowiki
 ```
 
-This will:
-1. Explore your codebase with parallel sub-agents
-2. Identify key concepts, components, and patterns
-3. Create wiki pages in the `wiki/` directory
-4. Generate `llms.txt` for AI discoverability
+Open http://localhost:3000 and you're in.
 
-### Update the wiki
+## Plugin Commands
 
-After making code changes:
+| Command | Description |
+|---------|-------------|
+| `/autowiki:init` | Generate a wiki from scratch by exploring the codebase |
+| `/autowiki:update` | Update the wiki to reflect recent code changes |
+| `/autowiki:reorganize` | Analyze wiki structure and suggest improvements |
 
-```
-/agent-wiki:update
-```
-
-By default, the wiki auto-updates after agent tasks complete. Disable this in `wiki/.config.yml`:
+The wiki also auto-updates after Claude Code tasks complete. Disable this in `wiki/.config.yml`:
 
 ```yaml
 auto_update: false
 ```
 
-### Browse the wiki
+## Web Server Options
 
-Start the local web server:
-
-```
-/agent-wiki:serve
 ```
+npx autowiki [options]
 
-Then open http://localhost:3000 in your browser.
-
-### Reorganize
-
-If the wiki grows unwieldy:
-
-```
-/agent-wiki:reorganize
+  --port <number>     Port to listen on (default: 3000)
+  --wiki-dir <path>   Wiki directory (default: auto-detect)
+  --export            Export static HTML files
+  --output <path>     Export directory (default: wiki-html/)
+  --open              Open browser automatically
 ```
 
-This analyzes the structure and suggests/applies improvements like splitting large pages or merging small ones.
+## Wiki Format
 
-## Wiki Structure
+Pages are markdown files with YAML frontmatter, organized by type:
 
 ```
 wiki/
-├── .config.yml       # Configuration
-├── .index.json       # Page index for fast lookups
-├── .last-update      # Git commit of last update
-├── llms.txt          # AI-friendly index
-├── llms-full.txt     # Complete content dump
 ├── overview.md       # Repository overview
-└── [concept].md      # One page per concept
-```
-
-## Page Format
-
-Each wiki page uses YAML frontmatter:
-
-```markdown
----
-title: Authentication System
-type: concept
-tags: [auth, security]
-related:
-  - "[[User Session]]"
-  - "[[API Gateway]]"
-sources:
-  - src/auth/
-  - src/middleware/auth.ts
----
-
-# Authentication System
-
-Description and documentation...
-
-## Code References
-
-- `src/auth/index.ts:15` - Main entry point
-- `src/auth/jwt.ts:42-78` - Token validation
+├── concepts/         # Architecture, design patterns
+├── guides/           # How-to documentation
+└── reference/        # API and config reference
 ```
 
-## Wikilinks
-
-Pages are connected using `[[wikilinks]]`:
-
-- `[[Page Name]]` - Links by title
-- `[[page-name]]` - Links by slug
-- `[[Page Name|display text]]` - Custom display text
-- `[[subdir/page]]` - Explicit path for disambiguation
-
-Resolution order:
-1. Exact title match
-2. Aliases in frontmatter
-3. Slugified filename
-
-## Configuration
-
-Edit `wiki/.config.yml`:
-
-```yaml
-# Auto-update after tasks (default: true)
-auto_update: true
-
-# Page organization strategy
-page_granularity: concept  # concept | directory | module
-
-# Paths to exclude
-exclude:
-  - node_modules/
-  - dist/
-  - "*.min.js"
-
-# Custom concept groupings
-concepts:
-  authentication:
-    - src/auth/
-    - src/middleware/auth*
-```
+Pages link to each other with `[[wikilinks]]` and track which source files they document, so the wiki knows what to update when code changes.
 
 ## Requirements
 
-- Python 3.8+ (for llms.txt generation)
-- Node.js 16+ (for web server)
-- PyYAML (`pip install pyyaml`)
-
-## How It Works
-
-1. **Exploration**: Sub-agents partition the codebase and explore in parallel
-2. **Coordination**: A coordinator agent synthesizes findings into wiki pages
-3. **Updates**: Git-based change detection identifies what needs updating
-4. **Auto-trigger**: Optional hook updates wiki after task completion
+- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) (for the plugin)
+- Node.js 16+ (for the web server)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "autowiki",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "Browse auto-generated wiki documentation in your browser",
   "bin": {
     "autowiki": "./bin/autowiki.js"
@@ -22,5 +22,10 @@
     "markdown",
     "codebase"
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/anyweez/autowiki.git"
+  },
+  "homepage": "https://github.com/anyweez/autowiki",
   "license": "MIT"
 }