@@ -139,8 +139,8 @@ codewiki generate --create-branch --github-pages --verbose
139139CodeWiki supports customization for language-specific projects and documentation styles:
140140
141141``` bash
142- # C# project: only analyze .cs files, exclude tests
143- codewiki generate --include " *.cs" --exclude " * Tests*,* Specs* "
142+ # C# project: only analyze .cs files, exclude test directories
143+ codewiki generate --include " *.cs" --exclude " Tests, Specs,*.test.cs "
144144
145145# Focus on specific modules with architecture-style docs
146146codewiki generate --focus " src/core,src/api" --doc-type architecture
@@ -149,6 +149,21 @@ codewiki generate --focus "src/core,src/api" --doc-type architecture
149149codewiki generate --instructions " Focus on public APIs and include usage examples"
150150```
151151
152+ #### Pattern Behavior (Important!)
153+
154+ - ** ` --include ` ** : When specified, ** ONLY** these patterns are used (replaces defaults completely)
155+ - Example: ` --include "*.cs" ` will analyze ONLY ` .cs ` files
156+ - If omitted, all supported file types are analyzed
157+ - Supports glob patterns: ` *.py ` , ` src/**/*.ts ` , ` *.{js,jsx} `
158+
159+ - ** ` --exclude ` ** : When specified, patterns are ** MERGED** with default ignore patterns
160+ - Example: ` --exclude "Tests,Specs" ` will exclude these directories AND still exclude ` .git ` , ` __pycache__ ` , ` node_modules ` , etc.
161+ - Default patterns include: ` .git ` , ` node_modules ` , ` __pycache__ ` , ` *.pyc ` , ` bin/ ` , ` dist/ ` , and many more
162+ - Supports multiple formats:
163+ - Exact names: ` Tests ` , ` .env ` , ` config.local `
164+ - Glob patterns: ` *.test.js ` , ` *_test.py ` , ` *.min.* `
165+ - Directory patterns: ` build/ ` , ` dist/ ` , ` coverage/ `
166+
152167#### Setting Persistent Defaults
153168
154169Save your preferred settings as defaults:
@@ -157,8 +172,8 @@ Save your preferred settings as defaults:
157172# Set include patterns for C# projects
158173codewiki config agent --include " *.cs"
159174
160- # Exclude test projects by default
161- codewiki config agent --exclude " * Tests*,* Specs*,test_* "
175+ # Exclude test projects by default (merged with default excludes)
176+ codewiki config agent --exclude " Tests, Specs,*.test.cs "
162177
163178# Set focus modules
164179codewiki config agent --focus " src/core,src/api"
@@ -173,13 +188,13 @@ codewiki config agent
173188codewiki config agent --clear
174189```
175190
176- | Option | Description | Example |
177- | --------| -------------| ---------|
178- | ` --include ` | File patterns to include | ` *.cs ` , ` *.py,*.pyi ` |
179- | ` --exclude ` | Patterns to exclude | ` *Tests* ` , ` *test*,*mock* ` |
180- | ` --focus ` | Modules to document in detail | ` src/core,src/api ` |
181- | ` --doc-type ` | Documentation style | ` api ` , ` architecture ` , ` user-guide ` , ` developer ` |
182- | ` --instructions ` | Custom agent instructions | Free-form text |
191+ | Option | Description | Behavior | Example |
192+ | --------| -------------| ---------- | --------- |
193+ | ` --include ` | File patterns to include | ** Replaces ** defaults | ` *.cs ` , ` *.py ` , ` src/**/*.ts ` |
194+ | ` --exclude ` | Patterns to exclude | ** Merges ** with defaults | ` Tests,Specs ` , ` *. test.js ` , ` build/ ` |
195+ | ` --focus ` | Modules to document in detail | Standalone option | ` src/core,src/api ` |
196+ | ` --doc-type ` | Documentation style | Standalone option | ` api ` , ` architecture ` , ` user-guide ` , ` developer ` |
197+ | ` --instructions ` | Custom agent instructions | Standalone option | Free-form text |
183198
184199### Configuration Storage
185200
0 commit comments