Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aeksco/hardcider
:beer: CLI for quickly generating citations for websites and books
https://github.com/aeksco/hardcider
bibliography citation cli commanderjs ieee mla node puppeteer
Last synced: about 2 months ago
JSON representation
:beer: CLI for quickly generating citations for websites and books
- Host: GitHub
- URL: https://github.com/aeksco/hardcider
- Owner: aeksco
- License: mit
- Created: 2018-11-09T04:22:06.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-14T19:37:57.000Z (about 6 years ago)
- Last Synced: 2024-10-14T06:45:10.723Z (2 months ago)
- Topics: bibliography, citation, cli, commanderjs, ieee, mla, node, puppeteer
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/hardcider
- Size: 429 KB
- Stars: 19
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# hardcider
:beer: Create citations from the command line
### Installation
Run the following command to install `hardcider` - requires Node.js 8.x and higher
```shell
npm install -g hardcider
```
### Usage
- **`hardcider website `** - create a website citation from a URL
- **`hardcider book `** - create a book citation from an ISBN-10 or ISBN-13
### Example
```shell
$ hardcider website --mla https://en.wikipedia.org/wiki/John_Coltrane
Fetching MLA citation...
“John Coltrane.” Wikipedia, Wikimedia Foundation, 24 Oct. 2018, en.wikipedia.org/wiki/John_Coltrane.
```
**Flags**
The following flags apply to both the `website` and `book` commands
- `--mla` - returns an [MLA](https://owl.purdue.edu/owl/research_and_citation/mla_style/mla_style_introduction.html) Formatted Citation (default)
- `--apa` - returns an [APA](https://owl.purdue.edu/owl/research_and_citation/apa_style/apa_style_introduction.html) Formatted Citation
- `--chicago` - returns a [Chicago](https://www.chicagomanualofstyle.org/home.html) Formatted Citation
- `--ieee` - returns an [IEEE](https://pitt.libguides.com/citationhelp/ieee) Formatted Citation
- `--bibtex` - returns an [BibTeX](http://www.bibtex.org/) Formatted Citation
### Thanks
Built with [commanderjs](https://github.com/tj/commander.js/), [chalk](https://github.com/chalk/chalk), [puppeteer](https://github.com/GoogleChrome/puppeteer/), and [citationmachine.net](http://www.citationmachine.net/). Open Source under the [MIT License](https://opensource.org/licenses/MIT).
### Note
This implementation uses [puppeteer](https://github.com/GoogleChrome/puppeteer/), a headless Chromium browser to navigate through a series of forms on [citationmachine.net](http://www.citationmachine.net/). It's faster than manually using any citation website I've come across, but it's admittedly a resource-intensive approach.