mhucka/zoinks

Command-line utility to return Zotero record field values given a Zotero select link, an item key, or even just a file attachment

Zoinks

Zoinks (Zotero information quick search) is a command-line utility that returns the values of selected fields of a bibliographic record given a Zotero select link, an item key, or even the path to a file attachment in your Zotero database.

Table of contents

• Introduction
• Installation
• Usage
• Known issues and limitations
• Getting help
• Contributing
• License
• Acknowledgments

Introduction

"Shaggy has a characteristic speech pattern, marked by his frequent use of the filler word "like" and, when startled, his exclamations of "Zoinks!" — from the Wikipedia entry for Shaggy Rogers, retrieved on 2020-12-15. An archived copy is available in the Wayback Machine.

When using Zotero in scripts and other software, you may need a way to retrieve information about bibliographic entries without searching for them in Zotero itself. Zoinks (a loose acronym for Zotero information quic**k search) is a program that lets you do this from the command line.

Zoinks is a companion to Zowie, a command-line application that writes Zotero select links into PDF files to make them accessible outside of Zotero.

Installation

[... forthcoming ...]

Usage

[... forthcoming ...]

Known issues and limitations

[... forthcoming ...]

Getting help

If you find an issue, please submit it in the GitHub issue tracker for this repository.

Contributing

I would be happy to receive your help and participation if you are interested. Everyone is asked to read and respect the code of conduct when participating in this project. Development generally takes place on the development branch.

License

This software is Copyright (C) 2022–2023, by Michael Hucka and the California Institute of Technology (Pasadena, California, USA). This software is freely distributed under a 3-clause BSD type license. Please see the LICENSE file for more information.

Acknowledgments

This work is a personal project developed by the author, using computing facilities and other resources of the California Institute of Technology Library.

The vector artwork of a surprised person, used as the icon for this repository, was created by Adrien Coquet from the Noun Project. It is licensed under the Creative Commons CC-BY 3.0 license.