You’re reading the ZotLit v2 docs. Still on v1? Read the v1 docs

ZotLit

Commands

Every ZotLit command-palette command, its entry points, and when it is available.

This page documents every command registered by ZotLit. Each command is listed with its palette name, additional entry points (ribbon, file menu, context menu), and availability conditions.

ZotLit is a desktop-only plugin. These commands are not available on Obsidian Mobile.

Database

ZotLit: Refresh Zotero database

Reloads the Zotero database from disk. Use this after making changes in Zotero when automatic watching is disabled.

Entry pointDetails
Command paletteAlways available

Library-wide update

ZotLit: Create or update all literature notes

Creates or updates a literature note for every item in the active library. Opens the same batch confirmation modal as a multi-item update from Zotero.

Entry pointDetails
Command paletteAlways available
ZoteroRight-click a library or collection > ZotLit > Create or Update Literature Notes

The Zotero entry scopes the batch to the row you right-click: a library covers every item in it, a collection covers that collection and its subcollections.

Library-wide note import

ZotLit: Import all child and standalone notes

Imports every note in the active library — the child notes attached to regular items and standalone notes alike. Opens the same batch confirmation modal as a multi-note import from Zotero.

Entry pointDetails
Command paletteAlways available
ZoteroRight-click a library or collection > ZotLit > Import Child and Standalone Notes

The Zotero entry scopes the import to the row you right-click, subcollections included.

Literature note quick switcher

ZotLit: Open literature note quick switcher

Opens a modal to search your Zotero library and jump to (or create) the corresponding literature note.

Entry pointDetails
Command paletteAlways available

Citations

ZotLit: Insert Markdown citation

Opens a modal to search your library and insert a Markdown citation at the cursor.

Entry pointDetails
Command paletteActive when an editor is open
Editor suggesterTriggered by typing [@ in the editor, or @ at a word boundary when @ trigger is on. Both settings are under Settings → ZotLit → Citations.

Literature note actions

The following commands operate on a literature note: the file currently open in the editor must be a ZotLit literature note. They also appear in the file menu (right-click the tab or use the file menu icon) under the zotlit section.

ZotLit: Update literature note

Re-renders the full literature note (frontmatter and managed body region) from the current Zotero data.

Entry pointDetails
Command paletteActive on a literature note
File menuyes

ZotLit: Update literature note metadata

Re-renders only the frontmatter of the literature note from the current Zotero data. Body content is unchanged.

Entry pointDetails
Command paletteActive on a literature note
File menuyes

ZotLit: Overwrite literature note

Destructively replaces the entire literature note with a fresh render. A confirmation modal appears before proceeding.

Entry pointDetails
Command paletteActive on a literature note
File menuyes

ZotLit: Import child notes from Zotero

Imports the Zotero notes attached to the current item into the vault.

Entry pointDetails
Command paletteActive on a literature note
File menuyes

ZotLit: Copy item key

Copies the note's Zotero key to the clipboard.

Entry pointDetails
Command paletteActive on a literature note
File menuLabel: Copy item key. Single file only.

Imported note actions

ZotLit: Update imported note from Zotero

Re-imports a Zotero note that was previously imported. A confirmation modal appears before overwriting.

Entry pointDetails
Command paletteActive on an imported note (file has a Zotero note key)
File menuyes

Annotations

ZotLit: Open Zotero annotations

Opens the annotation view in the right sidebar, showing annotations from the Zotero reader.

Entry pointDetails
Command paletteAlways available
Ribbonyes (tooltip: "Open Zotero annotations")

Template data explorer

ZotLit: Open template data explorer

Opens the template data explorer, showing the full data object available to templates for the current item.

Entry pointDetails
Command paletteAlways available
File menuLabel: Explore template data. Appears on files that carry an item key.

Onboarding & release

ZotLit: Open welcome view

Opens the ZotLit Welcome View — the onboarding screen with guided setup and v1-to-v2 migration.

Entry pointDetails
Command paletteAlways available
AutomaticOpens on first launch, and after a v1-to-v2 upgrade

ZotLit: Open release notes

Opens the release notes for the installed ZotLit version.

Entry pointDetails
Command paletteAlways available
SettingsThe What's new button (View release notes) in the settings tab
Update noticeThe action button on the "update available" notice

Entry-point summary

CommandPaletteRibbonFile menuEditor
Refresh Zotero databaseyes
Create or update all literature notesyes
Import all child and standalone notesyes
Open literature note quick switcheryes
Insert Markdown citationyes[@ / @ suggester
Update literature noteyesyes
Update literature note metadatayesyes
Overwrite literature noteyesyes
Import child notes from Zoteroyesyes
Copy item keyyesyes
Update imported note from Zoteroyesyes
Open Zotero annotationsyesyes
Open template data exploreryesyes
Open welcome viewyes
Open release notesyes

Template Workbench CLI

The Template Workbench registers additional commands through the Obsidian CLI for agent use. These commands are not in the command palette. They cover template inspection, rendering, and managed frontmatter configuration. See Template Workbench for an overview, and run obsidian-cli zotlit:template-guide for the command reference.

See also

On this page