You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -125,7 +125,7 @@ gitingest --help
125
125
126
126
### Using Multiple Patterns (CLI)
127
127
128
-
You can specify multiple patterns to include or exclude files and directories by repeating the respective flags (-e for exclude, -i for include). Patterns use standard shell wildcards.
128
+
You can specify multiple patterns to include or exclude files and directories by repeating the respective flags (`-e` for exclude, `-i` for include). Patterns use standard shell wildcards.
129
129
130
130
```bash
131
131
# Example 1: Exclude all log files, temporary files, and the entire 'dist' directory
Remember that exclusion patterns take precedence. If specific include patterns are provided, only files matching those and not matching any exclude pattern will be processed.
@@ -179,11 +179,11 @@ result = asyncio.run(ingest_async("path/to/directory"))
179
179
180
180
### Advanced Pattern Usage (Python API)
181
181
182
-
The Python API allows for fine-grained control by combining include_patterns and exclude_patterns. When both are provided:
182
+
The Python API allows for fine-grained control by combining `include_patterns` and `exclude_patterns`. When both are provided:
183
183
184
-
Files/directories are first checked against all exclusion patterns (default built-in patterns + user-provided exclude_patterns). If a match occurs, the item is skipped.
184
+
Files/directories are first checked against all exclusion patterns (default built-in patterns + user-provided `exclude_patterns`). If a match occurs, the item is skipped.
185
185
186
-
If include_patterns are specified, any remaining item must also match at least one of the include patterns to be kept. If include_patterns is None or empty, this step is skipped.
186
+
If `include_patterns` are specified, any remaining item must also match at least one of the include patterns to be kept. If `include_patterns` is None or empty, this step is skipped.
187
187
188
188
```python
189
189
# Advanced Python API Example
@@ -229,7 +229,7 @@ async def run_async_ingest():
229
229
# asyncio.run(run_async_ingest())
230
230
```
231
231
232
-
This setup ensures that even if src/ contains log files, they will be explicitly removed from the final digest, while only other files directly within src/ are included.
232
+
This setup ensures that even if `src/` contains log files, they will be explicitly removed from the final digest, while only other files directly within `src/` are included.
0 commit comments