Refs reference manager

A simple cli for generating APA-style references from a JSON file.


Download .zip Download .tar.gz

Refs: References manager

The refs cli takes in a json file and returns references in the APA format.

Showcase

showcase

Overview

For usage of the available commands and flags, check the overview.

For more information on the Json file, check the Json file section

Templating engine

There is also a templating engine for replacing citations in your text. For example, writing [#1] in your text will replace it with the reference with the corresponding id 1.

These are the available templates:

  • [#1] -> (Belleflamme, Lambert & Schwienbacher, 2014)
  • [#1!] -> Belleflamme, Lambert and Schwienbacher (2014)
  • [#1&2] -> (Belleflamme, Lambert & Schwienbacher, 2014; Paschen, 2017)
  • [#1&2!] -> Belleflamme, Lambert & Schwienbacher, 2014 and Paschen, 2017

For more information on the template engine, go to its dedicated page.

Download

Copy the repository using git clone https://github.com/Jomy10/refs, or you can download it here.

Download .zip Download .tar.gz

You will need to have Ruby installed.

After you’ve downloaded the package, do either of the following:

Install using script

Go into the copied folder and run ./install.rb.

Manual installs

Go into your /usr/local/bin, then run

ln -s refs /path/to/copied/repo/src/cli.rb

See the GitHub page for instructions on Windows.

Questions

If you have any questions, feel free to open an issue on the GitHub page

License

The code is licensed under the MIT License.

If this was helpful for you, consider leaving a star on GitHub!