Skip to content

getCommunityPluginRepo

Resolves the owner/name GitHub repository of a community plugin from Obsidian’s public community-plugins.json registry.

The registry is fetched once and cached on the shared plugin state for subsequent calls; a failed fetch is not cached, so a later call retries.

Import:

import { getCommunityPluginRepo } from 'obsidian-dev-utils/obsidian/community-plugins';

Signature:

function getCommunityPluginRepo(pluginId: string): Promise<string | null>

Parameters:

ParameterTypeDescription
pluginIdstringThe plugin id to look up.

Returns: Promise<string | null> — A Promise resolving to the plugin’s owner/name repository, or null if the plugin is not listed in the registry.