Git Product home page Git Product logo

doccer's Introduction

Doccer

Doccer is a very simple command-line reference manager, and is currently a work in progress. The name is a pun on Docker (don't sue me, please) and "document".

It stores all entries as a .json file at ~/.doccer/doccer-library.json. This library can be exported to .bibtex format (see Usage).

Currently supported fields are:

  • Title
  • Year
  • Journal
  • Folder (zero or one, for organizational purposes)
  • Tags (zero or more, for organizational purposes) (should be comma-seperated, see Usage)
  • Publisher
  • Type (see Bibtex Entry Types)

Pre-1.0 to-dos include:

  • Removing items
  • Naive text search support
  • Field text search support
  • Field regex search support
  • Support Bibtex types other than article
  • Multiple author support
  • Author last and first name support
  • Bibtex import support
  • Other import formats
  • Other export formats

There is no official roadmap as of yet (and there probably never will be).

Installation

Ensure you have Elixir installed (version 1.9 or greater), then clone the repository and run mix deps.get && mix escript.build to create a doccer executable, which you can run using ./doccer.

Usage

Add an item to your library:

doccer add --author "David Graeber" --year "2015" --title "The Utopia of Rules: On Technology, Stupidity, and the Secret Joys of Bureaucracy"

With a folder and tags:

doccer add --author "David Graeber" --year "2015" --title "The Utopia of Rules: On Technology, Stupidity, and the Secret Joys of Bureaucracy" --folder "Social Theory" --tags "Bureaucracy, anthopology"

Remove all items matching a given field from the library (case-insensitive):

doccer remove --author "Ayn Rand"

Export the library as bibtex to stdout:

doccer export

Export the library as bibtex, and copy to clipboard (currently only macOS is supported, please open an issue if you are on another platform):

doccer export --copy

License

Doccer is licensed under the GNU General Public License Version 3 (see LICENSE). In short, this means you can do whatever you want with this, as long as you ensure others can, in turn, do whatever they want to do with your work. It also ensures I am not liable if you accidentally nuke your entire reference library (please back up your files).

doccer's People

Contributors

niekvandepas avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.