Skip to content

installCommunityPlugin

Installs a community plugin from the official store if it is not already installed. Idempotent — a no-op when the plugin is already installed. Resolves the plugin’s repository from Obsidian’s community registry, reads the latest release version and its manifest, and installs it through Obsidian’s own installPlugin path.

Import:

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

Signature:

function installCommunityPlugin(params: InstallCommunityPluginParams): Promise<void>

Parameters:

ParameterTypeDescription
paramsInstallCommunityPluginParamsThe InstallCommunityPluginParams.

Returns: Promise<void> — A Promise that resolves once the plugin is installed.


Links to this page: