raggrep 0.8.1 → 0.8.3

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.
package/README.md CHANGED
@@ -103,13 +103,49 @@ raggrep query "api" -f src/api -f src/routes # Multiple path filters
103
103
  raggrep query "\`AuthService\` class" # Exact identifier match (backticks)
104
104
  ```
105
105
 
106
- | Flag | Short | Description |
107
- | ----------------- | ----- | -------------------------------------------------- |
108
- | `--top <n>` | `-k` | Number of results to return (default: 10) |
109
- | `--min-score <n>` | `-s` | Minimum similarity score 0-1 (default: 0.15) |
110
- | `--type <ext>` | `-t` | Filter by file extension (e.g., ts, tsx, js) |
111
- | `--filter <path>` | `-f` | Filter by path prefix (can be used multiple times) |
112
- | `--help` | `-h` | Show help message |
106
+ | Flag | Short | Description |
107
+ | ----------------- | ----- | ---------------------------------------------------------- |
108
+ | `--top <n>` | `-k` | Number of results to return (default: 10) |
109
+ | `--min-score <n>` | `-s` | Minimum similarity score 0-1 (default: 0.15) |
110
+ | `--type <ext>` | `-t` | Filter by file extension (e.g., ts, tsx, js) |
111
+ | `--filter <path>` | `-f` | Filter by path or glob pattern (can be used multiple times)|
112
+ | `--help` | `-h` | Show help message |
113
+
114
+ ### Filtering by File Type
115
+
116
+ Use glob patterns with `--filter` to search specific file types:
117
+
118
+ ```bash
119
+ # Search only source code files
120
+ raggrep query "service controller" --filter "*.ts"
121
+ raggrep query "component state" --filter "*.tsx"
122
+
123
+ # Search only documentation
124
+ raggrep query "deployment workflow" --filter "*.md"
125
+
126
+ # Search test files
127
+ raggrep query "mock setup" --filter "*.test.ts"
128
+
129
+ # Combine with path prefix
130
+ raggrep query "api handler" --filter "src/**/*.ts"
131
+ ```
132
+
133
+ ### Multiple Filters (OR Logic)
134
+
135
+ Use multiple `--filter` flags to match files that match **any** of the patterns:
136
+
137
+ ```bash
138
+ # Search TypeScript OR TSX files
139
+ raggrep query "component" --filter "*.ts" --filter "*.tsx"
140
+
141
+ # Search in multiple directories
142
+ raggrep query "api" --filter src/api --filter src/routes
143
+
144
+ # Mix glob patterns and path prefixes
145
+ raggrep query "config" --filter "*.json" --filter "*.yaml" --filter config/
146
+ ```
147
+
148
+ This is useful when you know whether you're looking for code or documentation.
113
149
 
114
150
  ### Index Options
115
151