Skip to content

Commit 09e0eb9

Browse files
docs: Add missing CLI flags documentation [AI-assisted] (#211)
Add documentation for three previously undocumented CLI flags in the user guide: - --relax-bibtex: Enables relaxed BibTeX parsing for handling malformed files - --confirm: Skips confirmation prompt for clear-cache automation - Backend filtering: Allows selective sync of specific backends These flags existed in the CLI implementation but were missing from user documentation. Organized under appropriate sections with usage examples and use cases. Resolves #202 Co-authored-by: florath-ai-assistant[bot] <Andreas.Florath@telekom.de>
1 parent 7f84a34 commit 09e0eb9

File tree

1 file changed

+61
-2
lines changed

1 file changed

+61
-2
lines changed

docs/user-guide.md

Lines changed: 61 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,26 @@ submit: check-refs
179179
submit-manuscript.sh
180180
```
181181

182+
#### Handling Malformed BibTeX Files
183+
184+
When working with BibTeX files from various sources, you may encounter files with non-standard formatting or syntax issues. The `--relax-bibtex` flag enables relaxed parsing mode to handle these cases:
185+
186+
```bash
187+
# Enable relaxed parsing for malformed BibTeX files
188+
aletheia-probe bibtex --relax-bibtex references.bib
189+
190+
# Combine with other options
191+
aletheia-probe bibtex --relax-bibtex --format json references.bib
192+
```
193+
194+
**When to use `--relax-bibtex`:**
195+
- Processing BibTeX files from different bibliography managers
196+
- Handling files with non-standard formatting
197+
- Working with legacy or auto-generated BibTeX files
198+
- Troubleshooting parsing errors
199+
200+
This flag allows the parser to be more forgiving of common BibTeX syntax issues while still extracting journal information for assessment. See `src/aletheia_probe/cli.py` for implementation details.
201+
182202
#### BibTeX Output Examples
183203

184204
**Text format:**
@@ -271,13 +291,52 @@ cat journals.txt | xargs -I {} aletheia-probe journal --format json "{}" > resul
271291

272292
### Data Management
273293

294+
#### Syncing Backend Data
295+
296+
Update local cache with fresh data from configured backends:
297+
274298
```bash
275-
# Update backend data
299+
# Sync all backends
276300
aletheia-probe sync
277301

278-
# Clear local cache
302+
# Sync specific backends only
303+
aletheia-probe sync scopus
304+
aletheia-probe sync bealls doaj
305+
306+
# Force sync even if data appears fresh
307+
aletheia-probe sync --force
308+
```
309+
310+
**Backend filtering** allows selective synchronization of data sources rather than updating all backends. This is useful for:
311+
- Testing specific backend configurations
312+
- Reducing sync time when only certain data needs updating
313+
- Troubleshooting individual backend connections
314+
315+
To see available backend names, use `aletheia-probe status`. For implementation details, see `src/aletheia_probe/cli.py`.
316+
317+
#### Clearing the Cache
318+
319+
Remove all cached assessment results to force fresh queries:
320+
321+
```bash
322+
# Clear cache with confirmation prompt
279323
aletheia-probe clear-cache
280324

325+
# Clear cache without confirmation (for automation)
326+
aletheia-probe clear-cache --confirm
327+
```
328+
329+
The `--confirm` flag skips the interactive confirmation prompt, making it suitable for:
330+
- Automated scripts and workflows
331+
- CI/CD pipelines
332+
- Scheduled maintenance tasks
333+
- Non-interactive environments
334+
335+
**Note:** Clearing the cache does not remove backend data from sync operations, only assessment result caches.
336+
337+
#### Configuration
338+
339+
```bash
281340
# Show configuration
282341
aletheia-probe config
283342
```

0 commit comments

Comments
 (0)