Obsidian SDK
System

SystemInfo

System diagnostics and application reloading.

SystemInfo Module

Overview

The SystemInfo module exposes commands that provide diagnostics about the application version and allow UI reload or full restart.

Quick Start

const ver = await obsidian.systemInfo.version();
console.log('Obsidian version:', ver);

await obsidian.systemInfo.reload();

Usage

MethodCLI CommandDescription
version()obsidian versionReturns the current Obsidian version.
reload()obsidian reloadReloads the UI without quitting.
restart()obsidian restartRestarts the entire application.

Examples

const version = await obsidian.systemInfo.version();
await obsidian.systemInfo.reload();
await obsidian.systemInfo.restart();

Error Handling

try {
  await obsidian.systemInfo.restart();
} catch (e) {
  console.error('Restart failed:', e.message);
}

Best Practices

  • Use reload for UI‑level changes (theme, CSS) that do not affect core state.
  • Use restart after installing core plugins or when a full reset is needed.
  • Verify the version before performing migrations.

On this page