@ncukondo/search-hub
v0.1.4
Published
A CLI tool for systematic literature searching across multiple academic databases
Maintainers
Readme
@ncukondo/search-hub
A CLI tool for systematic literature searching across multiple academic databases.
Features
- Multi-database search: PubMed, ERIC, arXiv, Scopus (Web of Science, Embase planned)
- Unified query syntax: YAML-based DSL with automatic translation
- Reproducible searches: Full session logging for PRISMA reporting
- Resume support: Continue interrupted searches at DB or page level
- Reference manager integration: Works with reference-manager
Installation
npm install -g @ncukondo/search-hubRequires Node.js 22+.
Quick Start
- Initialize configuration:
search-hub initThis creates config and data directories in platform-specific locations:
| Platform | Config | Data |
|----------|--------|------|
| Linux | ~/.config/search-hub/ | ~/.local/share/search-hub/ |
| macOS | ~/Library/Preferences/search-hub/ | ~/Library/Application Support/search-hub/ |
| Windows | %APPDATA%/search-hub/Config/ | %LOCALAPPDATA%/search-hub/Data/ |
- Create a query file (
query.yaml):
name: my_review
description: "Literature search for scoping review"
query:
- field: title_abstract
terms:
keywords:
- diabetes
- "machine learning"
operator: OR
filters:
year_from: 2020
language:
- en- Run search:
search-hub search query.yaml- Export results:
search-hub export <session-id> --format idsDocumentation
- Query Guide - How to write query files
- Command Reference - All CLI commands and options
- Configuration - Setup and configuration
- Databases - Supported databases and tips
Development
# Install dependencies
npm install
# Run tests
npm test
# Lint
npm run lint
# Build
npm run buildLicense
MIT
