https://github.com/armael/papiers

A tool to index your papers/interesting links/... and quickly search through them
https://github.com/armael/papiers

Last synced: about 2 months ago
JSON representation

A tool to index your papers/interesting links/... and quickly search through them

• Host: GitHub
• URL: https://github.com/armael/papiers
• Owner: Armael
• License: bsd-2-clause
• Created: 2013-10-31T10:01:58.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2021-12-26T12:41:02.000Z (about 3 years ago)
• Last Synced: 2023-03-12T09:34:12.123Z (almost 2 years ago)
• Language: OCaml
• Homepage:
• Size: 243 KB
• Stars: 49
• Watchers: 7
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Papiers

*Papiers* is a tool to index your pdf files/research papers/… and quickly search through them.

## Build instructions

- Install the dependencies (`opam install batteries yojson ANSITerminal uri camlzip cmdliner cpdf lambda-term` if you have opam)

- Edit the `src/config.ml` if you want to change the default reader for the sources (default: `xdg-open`), or the colors.

- Then:

```

./configure  

make && sudo make install

```

You can build the html documentation for the `papierslib` library by running:

```

make doc

```

After that the generated documentation will be in the `papierslib_api.docdir`

directory.

## How to use *Papiers*

*Papiers* now works a bit like *git*: you have *papiers* repositories;

 a repository is located in a directory, and index sources that are

 contained in this directory.

- Initialize a new repository in the current directory: `papiers init`

- Add documents to the database: `papiers doc add interesting_paper.pdf`

- Make queries to the database: `papiers search keyword1 keyword2`

- Type `papiers --help` to see the other possibilities

A query is more or less simply a list of keywords, that are searched through the

documents informations, like the title, authors, sources and tags.

You may want to refine this keyword based search. It is possible in some way by

using prefixes:

- If you prepend a keyword with `tag:` or `ta:`, it will only match tags.

- Prepend with `title:` or `ti:`, it'll search only in titles.

- With `a:`, `au:` or `author:`, only in authors.

- With `s:`, `src:` or `source:`, only in sources.

- With `la:` or `lang:`, only for languages.