https://github.com/windingwind/know-ur-zotero

Status monitoring and analysis tool for Zotero.
https://github.com/windingwind/know-ur-zotero

developer-tools plugin zotero zotero-plugin zotero7

Last synced: 12 months ago
JSON representation

Status monitoring and analysis tool for Zotero.

• Host: GitHub
• URL: https://github.com/windingwind/know-ur-zotero
• Owner: windingwind
• License: agpl-3.0
• Created: 2025-03-13T16:26:16.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-06-09T14:22:36.000Z (about 1 year ago)
• Last Synced: 2025-06-11T12:49:25.376Z (about 1 year ago)
• Topics: developer-tools, plugin, zotero, zotero-plugin, zotero7
• Language: TypeScript
• Homepage:
• Size: 651 KB
• Stars: 16
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Know Ur Zotero: Status Monitoring and Analysis

[![zotero target version](https://img.shields.io/badge/Zotero-7-green?style=flat-square&logo=zotero&logoColor=CC2936)](https://www.zotero.org)

[![Using Zotero Plugin Template](https://img.shields.io/badge/Using-Zotero%20Plugin%20Template-blue?style=flat-square&logo=github)](https://github.com/windingwind/zotero-plugin-template)



  



## 🧩 Outline

[🧐 What is this?](#-what-is-this)

[👋 Install](#-install)

[🧲 API](#-api)

[🔧 Development](#-development)

[🔔 Disclaimer](#-disclaimer)

## 🧐 What is this?

This plugin can monitor the status of the Zotero desktop app with:

- **Activity Monitor**: Monitor the CPU usage of diffrent activities in Zotero. Useful for plugin debugging and performance optimization.

![Activity Monitor](./assets/monitor.png)

- **Status Indicator**: Show the status of the Zotero app in the toolbar.



  



- **Activity Log**: Log the status to file (menu: `Tools` -> `Start Recording Activity`).

## 👋 Install

- Download the plugin (.xpi file) from below.

  - [Latest Stable](https://github.com/windingwind/know-ur-zotero/releases/latest)

  - [All Releases](https://github.com/windingwind/know-ur-zotero/releases)

  _Note_: If you're using Firefox as your browser, right-click the `.xpi` and select "Save As.."

- In Zotero click `Tools` in the top menu bar and then click `Plugins`

- Go to the Extensions page and then click the gear icon in the top right.

- Select `Install Add-on from file`.

- Browse to where you downloaded the `.xpi` file and select it.

- Finish!

## 🧲 API

KuZ provides APIs for plugin developers in `Zotero.kuZ.api.${API_MODULE}`. See [`api.ts`](src/api.ts).

- `profiler`: Monitor the CPU usage of different activities in Zotero.

## 🔧 Development

This plugin is built based on the [Zotero Plugin Template](https://github.com/windingwind/zotero-plugin-template). See the setup and debug details there.

To start, run

```bash

git clone https://github.com/windingwind/know-ur-zotero.git

cd know-ur-zotero

npm install

npm run build

```

The plugin is built to `.scaffold/build/*.xpi`.

To debug, run

```bash

npm run start

```

This will open a new Zotero instance with the plugin installed.

## 🔔 Disclaimer

Use this code under AGPL. No warranties are provided. Keep the laws of your locality in mind!