Update Radar

by siulved54
5
4
3
2
1
Score: 51/100

Description

Checks your installed community add-ons for updates in the background, shows release notes and flags abandoned ones.

Reviews

No reviews yet.

Stats

0
stars
4,615
downloads
0
forks
45
days
1
days
1
days
28
total PRs
1
open PRs
0
closed PRs
27
merged PRs
0
total issues
0
open issues
0
closed issues
28
commits

Latest Version

a day ago

Changelog

  • New: theme updates. Community themes installed in the vault are checked the same way Obsidian does and listed in their own section, with update one, Update all themes (also a command), ignore this version, snooze and the wait setting. The theme in use is applied again after its update. A new setting, Check themes too (on), turns it off; nothing is requested for themes when none is installed.
  • Status bar: plugin and theme updates are counted separately ("2 plugin updates · 1 theme update").

README file from

Github

Update Radar

Checks your installed community plugins and themes for updates in the background, shows what changed, and tells you which plugins look abandoned. A successor to Plugin Update Tracker, which has not had a release in over a year.

The Plugin updates view listing four plugins with installed and available versions, release notes opened for one of them, and a plugin health section with a "No release in 2+ years" flag

Formerly "Plugin Update Checker" and, briefly, "Community Update Checker"; renamed because the directory does not allow the word "plugin" in a name and the second name was already taken by an earlier submission.

Obsidian only looks for plugin updates when you open Settings → Community plugins → Check for updates. This plugin does it for you, every few hours, and puts the answer in the status bar.

Interface languages: English, 简体中文, 日本語, 한국어, Español, Deutsch, Français, Português (Brasil) and Русский, following Obsidian's language setting. A translation that reads wrong? Open an issue with the text and what it should say.

What you get

  • Updates in the status bar. "3 plugin updates", hidden when there are none. Click it to open the list.
  • A list of what changed. Each row shows the installed version, the new one, and, when you open Release notes, the notes from the plugin's GitHub release, rendered as Markdown.
  • Update one or all. The same installer Obsidian uses; enabled plugins are reloaded afterwards.
  • Ignore this version. Skips exactly that version; the next release shows up again. Stop ignoring brings it back.
  • Snooze a plugin. Hide every update of one plugin for 1, 7, 30 or 90 days, from its row, its right-click menu or the Snooze updates of a plugin command. It comes back on its own, or use Unsnooze. Health warnings still show.
  • Wait before offering an update. Optional: list a new release under Waiting until Update Radar has seen it for 1, 3, 7, 14 or 30 days. Update now skips the wait; a newer release restarts it.
  • Go back to an earlier version. An update broke something? Right-click a plugin in the list, use the history button on an update row, open Install an earlier version at the bottom of the list, or run the command of the same name. You see the plugin's releases (up to 30) with version, date and the start of the notes; the installed one is marked, and a version that needs a newer Obsidian than yours is greyed out. Update Radar then stops offering the version you went back from.
  • Held by rules. If another plugin holds an update back (see Extension API), it is listed under Held by rules with who holds it and why. Update now installs it anyway.
  • Compatibility. An update that needs a newer Obsidian than yours is listed apart, with the version it needs, and is never offered.
  • Theme updates. Community themes installed in the vault are checked too, the same way Obsidian's own Settings → Appearance → Themes → Check for updates does, and listed in their own Theme updates section with Update or Update all themes. Updating downloads the new theme.css and manifest.json first and only then replaces them (the old files are put back if writing fails); the theme in use is applied again at once. Ignore this version, Snooze and Wait before offering an update work for themes as they do for plugins. A theme that needs a newer Obsidian than yours is listed with the version it needs; if an older release of it still supports your Obsidian (the theme's versions.json), that one is offered instead, as Obsidian does. Turn it off with Check themes too.
  • Plugin health. Flags plugins that were removed from the directory (with the reason), have had no release in two or more years, or are not from the directory (installed by hand or with BRAT).

Network use

This plugin sends web requests, to GitHub only. There is no analytics and no other service.

  • Once a day it reads three public files from obsidianmd/obsidian-releases (the plugin list, the removed list and the stats), the same ones Obsidian itself uses.
  • For each installed plugin from the directory, it reads that plugin's latest manifest.json from its GitHub releases, like Obsidian's own update check.
  • When at least one community theme is installed (and Check themes too is on), it reads the theme list community-css-themes.json from obsidianmd/obsidian-releases once a day, and for each installed theme from that list its manifest.json from the theme's repository on raw.githubusercontent.com (and its versions.json when the latest version needs a newer Obsidian). Updating a theme downloads theme.css and manifest.json from the theme's GitHub release, or from the repository when there is no release, like Obsidian. Unlike Obsidian, it does not report theme downloads to releases.obsidian.md.
  • When you open Release notes on a row, it reads that release from the GitHub API.
  • When another plugin asks for a plugin to be installed (Extension API, install) and you agree, it reads the plugin list, finds that release on the GitHub API and downloads its files from there.
  • When you choose Install an earlier version, it lists the plugin's releases from the GitHub API and downloads main.js, manifest.json and styles.css from the release you pick.

Snoozing and waiting are worked out on your device; they send nothing.

Nothing about your vault, notes or settings is sent. The requests do reveal your IP address to GitHub, as any download would. Turn off Check shortly after Obsidian starts and set Check every to Never to check only when you ask.

Commands

Command What it does
Show plugin updates Opens the list. Also on the ribbon.
Check for plugin updates now Checks immediately and says how many updates there are.
Update all plugins Installs every update that is available and compatible.
Update all themes Installs every theme update that is available and compatible.
Install an earlier version of a plugin Choose a plugin, then one of its previous releases, and install it.
Snooze updates of a plugin Choose a plugin, then how long (1, 7, 30 or 90 days) to hide its updates.

Settings

Setting Default What it does
Check shortly after Obsidian starts on One check about 15 seconds after startup.
Check every 6 hours While Obsidian stays open. 1, 3, 6, 12 or 24 hours, or never.
Wait before offering an update off Days since Update Radar first saw the release: 1, 3, 7, 14 or 30. Off offers it at once.
Show the update count in the status bar on Hidden at zero. Not shown on mobile.
Include pre-releases when installing an earlier version off Also lists pre-releases. Drafts are never listed.
Check themes too on Also checks the community themes installed in the vault. Nothing is requested for themes when none is installed.

Extension API

Other plugins can build on Update Radar. Version 1 (1.1 since Update Radar 0.6.0, apiMinor: 1) is available as app.plugins.getPlugin('update-radar').api; a plugin that loads before Update Radar waits for the workspace event update-radar:api-ready, which carries the same object. The types are in src/api.ts, a file with no imports that can be copied as it is. apiVersion only goes up on a breaking change. The API sends nothing anywhere, and it does nothing until a plugin calls it.

Call What it does
reports() The last check: for each installed plugin its id, name, installed and newest version, repository and state (update, waiting, held, snoozed, ignored, blocked, current or none). A copy.
on('checked' | 'installed', listener) Hears when a check produced a list, and when a plugin was updated or put back to an earlier version. Returns a function that removes it.
beforeInstall(id, handler) Runs handler before every install and every return to an earlier version, one handler after the other. It may be async and return { veto: true, reason } to stop that install; the user sees the reason. A handler that throws, or takes more than 20 seconds, does not block anything.
holds(id, provider) Asked about each plugin that has an update on offer or waiting; returning { owner, label } moves it to Held by rules. Call refresh() after the rules change.
rowActions(id, provider) Adds entries to the right-click menu of every plugin row.
release(repo, version) The GitHub release (notes, date, link) of a version, cached; the same data as Release notes.
ignore(id, version) Skips exactly that version, like Ignore this version.
install(id, version) New in 1.1. Installs exactly that version of a directory plugin from its GitHub release, installed or not, and leaves it turned off. Update Radar always asks the user first, in its own window (plugin, version and repository), so nothing installs in silence; the answer is { ok, error? } and it never throws. beforeInstall handlers run only for a plugin that is already installed. Check typeof api.install === 'function' to support 0.5.x.
busy(), refresh() Whether a check or install is running; redraw the list from the last check (no network).

Registering the same id again replaces the earlier registration. Everything an extension registered is dropped when Update Radar unloads, so register again on update-radar:api-ready.

Notes

  • Updating uses Obsidian's internal plugin installer, which is not part of the public API. If a future Obsidian changes it, the plugin says so instead of failing silently; updating from Settings → Community plugins keeps working either way.
  • The plugin directory only serves the latest version of each plugin, so Install an earlier version downloads from the plugin's GitHub releases instead. Everything is downloaded and checked first (it must be the same plugin, and not need a newer Obsidian than yours). Only then are main.js, manifest.json and styles.css replaced, and if writing fails the old files are put back. The plugin's data.json is never touched. The plugin is then turned off and on again. A release without main.js and manifest.json attached cannot be installed. An older version may not understand settings a newer one saved; Update Radar cannot know.
  • Release notes are shown with code-block languages removed and [[links]] escaped, so nothing in them runs and nothing in them touches your vault.
  • Plugins with updates are installed one at a time; this plugin's own update is installed last.
  • "No release in 2+ years" uses the directory's last-release date. Plenty of finished plugins are stable rather than abandoned; the flag is a prompt to look, not a verdict.
  • Versions are compared as semantic versions, so 1.10.0 is newer than 1.9.0 and a pre-release such as 2.0.0-beta.1 is older than 2.0.0. A version that is not semver (four parts, a date) counts as an update whenever it differs, like Obsidian's own check.
  • "Wait before offering an update" counts from the day Update Radar first saw the release, because the manifest carries no date. That is never earlier than the real release, so a release is never offered too soon; on a fresh install the count starts that day.
  • Plugins that are not in the directory cannot be checked for updates and appear only under health.
  • Themes are matched to the theme directory by name, as Obsidian does. Themes that are not in the directory, legacy themes (a single obsidian.css from before Obsidian 0.16) and old single-file themes in the themes folder are not checked. Release notes, Install an earlier version, health flags and the Extension API are about plugins only: theme updates are not in reports() and fire no beforeInstall or installed events.

Pro

Update Radar Pro is an optional paid companion (one-time payment, 14-day free trial): a copy of each plugin before it updates, restore points to go back to how everything was, and a guided search for the plugin that breaks something. Everything described above stays free in this plugin.

Installation

In Obsidian, open Settings → Community plugins → Browse and search for "Update Radar".

More plugins by Siulved54

Plugin What it does Source
Shared Blocks Write a block of text once and reuse it in any note. Edit the source and every reference re-renders live. shared-blocks
Text Case and Cleanup Change case, make camelCase or slugs, sort lines and remove duplicates, and repair text pasted out of a PDF, without touching code or URLs. text-format
Typography as You Type Curly quotes, dashes and ellipses as you type, kept out of code and maths, with Backspace to take one back. smart-typography-plugin
Section Numbering Number headings as an outline (1, 1.1, 1.2) and keep every link to them working when they renumber. section-numbering
Spreadsheet to Table Paste cells from Excel or Google Sheets as a Markdown table with a real header, insert CSV files, and copy tables back out. spreadsheet-to-table
Hybrid Line Numbers Relative and hybrid line numbers for Vim-style jumps, where a folded section counts as one line. hybrid-line-numbers
List Item Callouts Colour a single list item as a callout by starting it with a character such as &, ! or ?. list-item-callouts
Folder Counts See how many notes or files each folder holds, right in the file explorer, with a vault total and folder exclusions. folder-counts
Note Reading Time Reading time of the current note or your selection in the status bar, optionally saved to a property. note-reading-time
Task Rollover Roll unfinished tasks from your last daily note into today's when it is created, with a real undo. task-rollover
Zoom Into Section Zoom into a heading or list item to see only it and its contents, with a breadcrumb bar to climb back out. zoom-into-section
Link Title on Paste Paste a web address and get a Markdown link with the page's title, fetched in the background and undone in one step. link-title-on-paste
Dataview to Bases Convert Dataview queries into Bases blocks, and see which queries in your vault can be converted. dataview-to-bases
Line Editing Commands Duplicate, join, sort and reverse lines, insert blank lines and jump to a line number, with multi-cursor support. line-editing-commands
Note Mover Rules Move notes into folders by ordered rules on tags, properties, titles and paths, with a preview before any bulk move. note-mover-rules
Tab History Keeps each tab's back and forward history across restarts, and adds commands to move, maximize and close tabs. tab-history
URL Cards Shows web addresses as cards with title, description and image, and reads existing cardlink blocks. url-cards
Vim Config Loads a vimrc-style file from your vault so your key mappings and editor commands are ready when vim mode starts. vim-config
Task Archive Moves completed tasks, with their sub-items, into an archive section or note. task-archive
Revisit Later Link the current note into a future daily note, with a date typed in plain English, so it comes back when you want to review it. revisit-later
Explorer Colors Plus Color files and folders in the file explorer, with a palette, cascading to children, and import from File Color. explorer-colors-plus
Book Lookup Create book notes from Open Library or Google Books, with cover images, ISBN search and Book Search compatible templates. book-lookup
Web Search Menu Search the web for selected text or the note title from the right-click menu, with engines you define. web-search-menu
Word Lookup Look up any word in a sidebar dictionary with definitions, phonetics, synonyms and antonyms, or create a note for it. word-lookup
Quick Translate Translate the selection or a whole note into another language with no account, keeping links, code and front matter untouched. quick-translate
Dice Rolls Inline dice rolls you click to reroll, in Live Preview and Reading view, with full dice notation, a roll dialog and a roll history. Reads Dice Roller notes. dice-rolls
Claude Studio Notion-style AI writing, chat and vault tools powered by your local Claude Code CLI. claude-studio
Book Studio Turn notes into a print-ready paperback PDF and an EPUB 3, entirely on your device. book-studio
Emoji Search Insert emojis from a searchable picker or by typing a :shortcode. emoji-search
Inline TOC Show a live table of contents inside any note with a toc code block, or insert a plain Markdown one. inline-toc

All of them are in the community directory: Settings -> Community plugins -> Browse, then search for the name. Demos and install links for every one: the catalog.

Pro and templates

Optional paid extras, one-time payment. Everything in the free plugins stays free.

Follow new plugins and updates on X: @luenpereza