colrev.local_index¶

Version: 0.1.0

Maintainer: Gerit Wagner

License: MIT

Endpoint	Status	Add
search_source		colrev search --add colrev.local_index
prep		colrev prep --add colrev.local_index
pdf_get		colrev pdf-get --add colrev.local_index

Summary¶

This package creates an sqlite database based on local CoLRev packages, providing meta-data and PDFs to other local packages.

To create or update the index, run

colrev env -i

search¶

API search¶

colrev search --add colrev.local_index -p "title LIKE '%dark side%'"

Format of the search-history file:

{
    "search_string": "",
    "platform": "colrev.local_index",
    "search_results_path": "data/search/local_index_dark_side.bib",
    "search_type": "API",
    "search_parameters": {
        "query": "outsourcing"
    },
    "version": "0.1.0"
}

pdf-get¶

Retrieves PDF documents from other local CoLRev repositories, given that they are registered, and that the index is updated.