https://github.com/OpenDevEd/zotero-lib
https://github.com/OpenDevEd/zotero-lib
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/OpenDevEd/zotero-lib
- Owner: OpenDevEd
- Created: 2020-12-08T18:05:26.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T08:12:17.000Z (4 months ago)
- Last Synced: 2024-10-23T11:38:54.447Z (4 months ago)
- Language: JavaScript
- Size: 33.8 MB
- Stars: 10
- Watchers: 6
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- jimsghstars - OpenDevEd/zotero-lib - (JavaScript)
README
# zotero-lib
## Introduction
Tools for working with the APIs of Zotero and Zenodo (zotzen)
This repository is part of a set of repositories, [see here](https://github.com/orgs/OpenDevEd/teams/zotzen-team/repositories). Currently, this set contains a number of libraries
- zenodo-lib [GitHub](https://github.com/opendeved/zenodo-lib), [npm](https://www.npmjs.com/package/zenodo-lib)
- zotero-lib [GitHub](https://github.com/opendeved/zotero-lib), [npm](https://www.npmjs.com/package/zotero-lib)
- zotzen-lib [GitHub](https://github.com/opendeved/zotzen-lib), [npm](https://www.npmjs.com/package/zotzen-lib)
(The above tools can also be installed as command-line tools (CLI) with `npm -g`.)
And a web application
- [zotzen-web](https://github.com/opendeved/zotzen-web)
This code builds on earlier code for [zotero-cli](https://github.com/OpenDevEd/zotero-cli), which was developed by [@bjohas](https://github.com/bjohas), [@retorquere](https://github.com/retorquere) and [@a1diablo](https://github.com/a1diablo).
## Installation
Install this library in a module with
```bash
npm install zotero-lib
yarn add zotero-lib
```
or as global CLI
```bash
npm install -g zotero-lib
yarn global add zotero-lib
```
View entry on [npm](https://www.npmjs.com/package/zotero-lib)
## Use of the library and the CLI
The directory tests/ contains a number of tests that illustrate the
use of the npm library. The file tests/test_cli.sh has examples for
use of the library from the command line.
## CLI Documentation
The zotero-cli allows you to access zoter from cmd line, it allows you to automate redundant taskse easily
## Basic usage
### Help
```bash
zotero-lib -h
zotero-lib --help
```
This will print help for all commands and options accepted by zotero-lib
### Version
```bash
zotero-lib -v
zotero-lib --version
```
This will print the version of cli you have installed
### create
This allows you to create item(s). You can create items in two different ways either by providing file containg json or json items as string
Both of these options can be used by providing following arguments
- `--files` - this accepts text files containing json
- `--items` - this accepts items as json string
**Note**: You must use only one of these at a time
Examples
```bash
zotero-lib create --files filepath.txt
zotero-lib create --items '{"title": "zotero item 1", "itemType": "book"}' '{"title": "zotero item 2", "itemType": "book"}'
```
### update
This sub-command can be used to update existing items
```bash
zotero-lib update --key key-here --json '{"title": "zotero item 1 updat", "itemType": "book"}'
zotero-lib update --key key-here --file filepath.txt
```
You can also specify option replace which completely replace existing item and only keep provided information
```bash
zotero-lib update --replace --key key-here --json '{"title": "zotero item 1 updat", "itemType": "book"}'
```
### item
This sub-command has various use cases
To fetch item
```bash
zotero-lib item --key key-here
```
To add files
```bash
zotero-lib item --key key-here --addfiles test.json
```
### items
This sub-command can be used to fetch items with various filters
```bash
zotero-lib items --filter '{"limit": 10}'
```
### collection
### collections
### publications
### tags
### attachment
### types
### groups
### fields
### searches
### key
### field
This sub-command can be used to fetch field information
```bash
zoetro-lib field --key key-here --field field-name
```
Modify field information
```bash
zoetro-lib field --key key-here --field field-name --value new-value
```
Or with `--extra` to fetch extra information
```bash
zoetro-lib field --extra --key key-here --field field-name
```
And modify extra information
```bash
zoetro-lib field --extra --key key-here --field field-name --value new-value
```
### update-url
### get-doi
### update-doi
### enclose-item
### attach-link
### attach-note
### kciaka
### bibliography
### Local Database Syncing
You can use this cli to locally backup your online zotero library. The `db` cmd allows you to sync online library in local sqlite database. On first run all online records are synced into local database. On subsequent runs only those records are fetched, which were modifed since last sync.
The underlying database is SQLite. You dont need to install any server or anything it will work out of box as SQLite comes bundled with this cli.
To use this cmd you need to provide your db name along with one or more options. The options which you can specify are detailed below.
`--sync` make local db synced with online library
`--lookup` allow you to lookup specific items in the local db
`--keys` this must be used with `--lookup` to specify specfic keys you want to locate
`--lockfile` name of lock file to be used, default is "sync.lock"
`--lock-timeout` if a lock file already exist, how much older it should be to classify it as outdated, if its outdated it will be removed and a new one will be generated
`--export-json=` export localdb as json with given `file-name.json`
`--demon=