ted-mosby 1.1.1 → 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +38 -9
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,23 +2,52 @@
2
2
 
3
3
  > "Kids, I'm going to tell you an incredible story... the story of your codebase architecture."
4
4
 
5
- An AI-powered CLI tool that generates comprehensive architectural documentation wikis for code repositories with source code traceability.
5
+ An AI-powered CLI that does two things:
6
+
7
+ 1. **Generates architectural wikis** with source code traceability (`file:line` references)
8
+ 2. **Works as an agentic coding assistant** like Claude Code
6
9
 
7
10
  **Built with [buildanagentworkshop.com](https://buildanagentworkshop.com)**
8
11
 
9
12
  ---
10
13
 
11
- ## What is Ted Mosby?
14
+ ## Two Ways to Use Ted Mosby
15
+
16
+ ### 1. Generate Documentation (`ted-mosby generate`)
17
+
18
+ Point Ted Mosby at any codebase and get a complete architectural wiki:
19
+
20
+ ```bash
21
+ ted-mosby generate -r ./my-project --site
22
+ ```
23
+
24
+ This creates:
25
+ - **Architecture Overview** with Mermaid diagrams
26
+ - **Module Documentation** with source traceability
27
+ - **Data Flow Documentation**
28
+ - **Getting Started Guides**
29
+ - **Interactive static site** with search, keyboard nav, dark mode
30
+
31
+ Every concept links directly to source code (`src/auth/jwt.ts:23-67`), so you can navigate from docs to implementation.
32
+
33
+ ### 2. Agentic Codebase Assistant
34
+
35
+ Under the hood, Ted Mosby is a full agentic coding assistant powered by Claude. It doesn't just template docs—it:
12
36
 
13
- Ted Mosby is an AI agent that reads your codebase and automatically generates professional architectural documentation. Unlike generic documentation tools, every concept in the generated wiki links directly to the source code (`file:line` references), making it easy to navigate from documentation to implementation.
37
+ - **Explores your codebase** using filesystem tools
38
+ - **Searches semantically** via RAG embeddings (FAISS + all-MiniLM-L6-v2)
39
+ - **Reasons about architecture** to identify patterns and relationships
40
+ - **Writes and verifies** documentation with automatic link checking
14
41
 
15
- ### Generated Documentation Includes:
42
+ ```bash
43
+ # The agent runs autonomously, reading files, searching code, writing docs
44
+ ted-mosby generate -r ./my-project --verbose
45
+
46
+ # Continue where you left off—agent resumes with cached context
47
+ ted-mosby continue -r ./my-project --skip-index
48
+ ```
16
49
 
17
- - **Architecture Overview** - High-level system design with Mermaid diagrams
18
- - **Module Documentation** - Per-component breakdowns with source traceability
19
- - **Data Flow Documentation** - How data moves through your system
20
- - **Getting Started Guides** - Onboarding documentation for new developers
21
- - **Glossary** - Key concepts and terminology
50
+ The same RAG system that powers documentation generation gives the agent deep, semantic understanding of your codebase—like Claude Code, but with your entire project pre-indexed for instant retrieval.
22
51
 
23
52
  ---
24
53
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ted-mosby",
3
- "version": "1.1.1",
3
+ "version": "1.1.2",
4
4
  "description": "Generate comprehensive architectural documentation wikis for code repositories with source traceability.",
5
5
  "main": "dist/cli.js",
6
6
  "bin": {