Command line usage¶
The refpapers command line interface is divided into several subcommands, each with their own argument signature.
This is the same type of interface that e.g. git uses.
The overall structure is refpapers <subcommand> [OPTIONS] [ARGUMENTS], for example refpapers search gronroos uses the search subcommand, with the query term gronroos.
Subcommands for search¶
refpapers search¶
Search for papers
The search uses the whoosh default query language. You can e.g. select the field to search, use boolean operators, truncation, range queries and more.
refpapers one¶
Show details of one paper.
A search is performed using the given query, and the details for the best match are shown. The most reliable way to select a single paper is to search by bibtex key.
refpapers open¶
Open one paper in viewer.
A search is performed using the given query, and the best match is opened in a separate viewer. The most reliable way to select a single paper is to search by bibtex key.
Subcommands for managing your data¶
refpapers index¶
Refresh the search index.
By deafult a fast incremental search will be used if git is enabled.
A full reindexing can be forced with the --full flag.
refpapers rename¶
Propose renaming a single file automatically.
refpapers inbox¶
Ingest files in inbox:
auto-rename all the files in the inbox,
commit the new files into git-annex,
sync the contents of git-annex,
index to make the new files searchable.
The --open flag causes documents to be opened in the viewer before renaming.
If you have the papers in fresh memory, you can omit this.
Otherwise, use it to remind yourself what the paper was about.
If a paper with similar metadata is already indexed, a warning will be shown.
refpapers check¶
Check for data issues.
My workflow¶
As I browse, I download pdfs into an “inbox” directory (separate from the main collection).
- In the inbox directory, I run
refpapers inbox --open. This auto-renames all the files in the inbox, commits the new files into git-annex, syncs the contents of git-annex, and indexes the new files.
- In the inbox directory, I run
On other machines, I run
git annex sync --content, and then reindex. Now the files are available on those machines as well.Periodically, I run refpapers check to check for problems.