Class default

The ObsidianLauncher class.

Helper class that handles downloading and installing Obsidian versions, plugins, and themes and launching Obsidian with sandboxed configuration directories.

Constructors

constructor

new default(
    options?: {
        cacheDir?: string;
        versionsUrl?: string;
        communityPluginsUrl?: string;
        communityThemesUrl?: string;
        cacheDuration?: number;
    },
): default
Construct an ObsidianLauncher.
Parameters
- options: {
      cacheDir?: string;
      versionsUrl?: string;
      communityPluginsUrl?: string;
      communityThemesUrl?: string;
      cacheDuration?: number;
  } = {}
  - OptionalcacheDir?: string
    Path to the cache directory. Defaults to "OBSIDIAN_CACHE" env var or ".obsidian-cache".
  - OptionalversionsUrl?: string
    Custom obsidian-versions.json url. Can be a file URL.
  - OptionalcommunityPluginsUrl?: string
    Custom community-plugins.json url. Can be a file URL.
  - OptionalcommunityThemesUrl?: string
    Custom community-css-themes.json url. Can be a file URL.
  - OptionalcacheDuration?: number
    If the cached version list is older than this (in ms), refetch it. Defaults to 30 minutes.
Returns default
- Defined in launcher.ts:53

Properties

`Readonly`cacheDir

cacheDir: string

`Readonly`versionsUrl

versionsUrl: string

`Readonly`communityPluginsUrl

communityPluginsUrl: string

`Readonly`communityThemesUrl

communityThemesUrl: string

`Readonly`cacheDuration

cacheDuration: number

Methods

getVersions

getVersions(): Promise<ObsidianVersionInfo[]>
Get information about all available Obsidian versions.

Returns Promise<ObsidianVersionInfo[]>
- Defined in launcher.ts:140

getCommunityPlugins

getCommunityPlugins(): Promise<ObsidianCommunityPlugin[]>
Get information about all available community plugins.

Returns Promise<ObsidianCommunityPlugin[]>
- Defined in launcher.ts:147

getCommunityThemes

getCommunityThemes(): Promise<ObsidianCommunityTheme[]>
Get information about all available community themes.

Returns Promise<ObsidianCommunityTheme[]>
- Defined in launcher.ts:154

resolveVersions

resolveVersions(
appVersion: string,
installerVersion?: string,
): Promise<[string, string]>
Resolves Obsidian app and installer version strings to absolute versions.
Parameters
- appVersion: string
  Obsidian version string or one of
  
  "latest": Get the current latest non-beta Obsidian version
  
  "latest-beta": Get the current latest beta Obsidian version (or latest is there is no current beta)
  
  "earliest": Get the minAppVersion set in your manifest.json
- installerVersion: string = "latest"
  Obsidian version string or one of
  
  "latest": Get the latest Obsidian installer compatible with appVersion
  
  "earliest": Get the oldest Obsidian installer compatible with appVersion
  
  See also: Obsidian App vs Installer Versions
Returns Promise<[string, string]>
[appVersion, installerVersion] with any "latest" etc. resolved to specific versions.
- Defined in launcher.ts:172

getVersionInfo

getVersionInfo(appVersion: string): Promise<ObsidianVersionInfo>
Gets details about an Obsidian version.
Parameters
- appVersion: string
  Obsidian app version
Returns Promise<ObsidianVersionInfo>
- Defined in launcher.ts:208

downloadInstaller

downloadInstaller(installerVersion: string): Promise<string>
Downloads the Obsidian installer for the given version and current platform. Returns the file path.
Parameters
- installerVersion: string
  Obsidian installer version to download
Returns Promise<string>
- Defined in launcher.ts:235

downloadApp

downloadApp(appVersion: string): Promise<string>
Downloads the Obsidian asar for the given version. Returns the file path.

To download beta versions you'll need to have an Obsidian account with Catalyst and set the OBSIDIAN_USERNAME and OBSIDIAN_PASSWORD environment variables. 2FA needs to be disabled.
Parameters
- appVersion: string
  Obsidian version to download
Returns Promise<string>
- Defined in launcher.ts:325

downloadChromedriver

downloadChromedriver(installerVersion: string): Promise<string>
Downloads chromedriver for the given Obsidian version.

wdio will download chromedriver from the Chrome for Testing API automatically (see https://github.com/GoogleChromeLabs/chrome-for-testing#json-api-endpoints). However, Google has only put chromedriver since v115.0.5763.0 in that API, so wdio can't automatically download older versions of chromedriver for old Electron versions. Here we download chromedriver for older versions ourselves using the @electron/get package which fetches chromedriver from https://github.com/electron/electron/releases.
Parameters
- installerVersion: string
  Obsidian installer version
Returns Promise<string>
- Defined in launcher.ts:362

downloadPlugins

downloadPlugins(plugins: PluginEntry[]): Promise<DownloadedPluginEntry[]>
Downloads a list of plugins to the cache and returns a list of DownloadedPluginEntry with the downloaded paths. Also adds the id property to the plugins based on the manifest.

You can download plugins from GitHub using {repo: "org/repo"} and community plugins using {id: 'plugin-id'}. Local plugins will just be passed through.
Parameters
- plugins: PluginEntry[]
  List of plugins to download.
Returns Promise<DownloadedPluginEntry[]>
- Defined in launcher.ts:466

downloadThemes

downloadThemes(themes: ThemeEntry[]): Promise<DownloadedThemeEntry[]>
Downloads a list of themes to the cache and returns a list of DownloadedThemeEntry with the downloaded paths. Also adds the name property to the plugins based on the manifest.

You can download themes from GitHub using {repo: "org/repo"} and community themes using {name: 'theme-name'}. Local themes will just be passed through.
Parameters
- themes: ThemeEntry[]
  List of themes to download
Returns Promise<DownloadedThemeEntry[]>
- Defined in launcher.ts:583

installPlugins

installPlugins(vault: string, plugins: PluginEntry[]): Promise<void>
Installs plugins into an Obsidian vault
Parameters
- vault: string
  Path to the vault to install the plugins in
- plugins: PluginEntry[]
  List plugins to install
Returns Promise<void>
- Defined in launcher.ts:639

installThemes

installThemes(vault: string, themes: ThemeEntry[]): Promise<void>
Installs themes into an Obsidian vault
Parameters
- vault: string
  Path to the theme to install the themes in
- themes: ThemeEntry[]
  List of themes to install
Returns Promise<void>
- Defined in launcher.ts:701

setupConfigDir

setupConfigDir(
    params: {
        appVersion: string;
        installerVersion: string;
        appPath?: string;
        vault?: string;
        dest?: string;
    },
): Promise<string>
Sets up the config dir to use for the --user-data-dir in obsidian. Returns the path to the created config dir.
Parameters
- params: {
      appVersion: string;
      installerVersion: string;
      appPath?: string;
      vault?: string;
      dest?: string;
  }
  - appVersion: string
    Obsidian app version
  - installerVersion: string
    Obsidian version string.
  - OptionalappPath?: string
    Path to the asar file to install. Will download if omitted.
  - Optionalvault?: string
    Path to the vault to open in Obsidian.
  - Optionaldest?: string
    Destination path for the config dir. If omitted it will create a temporary directory.
Returns Promise<string>
- Defined in launcher.ts:754

setupVault

setupVault(
    params: {
        vault: string;
        copy?: boolean;
        plugins?: PluginEntry[];
        themes?: ThemeEntry[];
    },
): Promise<string>
Sets up a vault for Obsidian, installing plugins and themes and optionally copying the vault to a temporary directory first.
Parameters
- params: {
      vault: string;
      copy?: boolean;
      plugins?: PluginEntry[];
      themes?: ThemeEntry[];
  }
  - vault: string
    Path to the vault to open in Obsidian
  - Optionalcopy?: boolean
    Whether to copy the vault to a tmpdir first. Default false
  - Optionalplugins?: PluginEntry[]
    List of plugins to install in the vault
  - Optionalthemes?: ThemeEntry[]
    List of themes to install in the vault
Returns Promise<string>
Path to the copied vault (or just the path to the vault if copy is false)
- Defined in launcher.ts:817

launch

launch(
    params: {
        appVersion?: string;
        installerVersion?: string;
        copy?: boolean;
        vault?: string;
        plugins?: PluginEntry[];
        themes?: ThemeEntry[];
        args?: string[];
        spawnOptions?: SpawnOptions;
    },
): Promise<{ proc: ChildProcess; configDir: string; vault?: string }>
Downloads and launches Obsidian with a sandboxed config dir and a specifc vault open. Optionally install plugins and themes first.

This is just a shortcut for calling downloadApp, downloadInstaller, setupVault and setupConfDir.
Parameters
- params: {
      appVersion?: string;
      installerVersion?: string;
      copy?: boolean;
      vault?: string;
      plugins?: PluginEntry[];
      themes?: ThemeEntry[];
      args?: string[];
      spawnOptions?: SpawnOptions;
  }
  - OptionalappVersion?: string
    Obsidian app version. Default "latest"
  - OptionalinstallerVersion?: string
    Obsidian installer version. Default "latest"
  - Optionalcopy?: boolean
    Whether to copy the vault to a tmpdir first. Default false
  - Optionalvault?: string
    Path to the vault to open in Obsidian
  - Optionalplugins?: PluginEntry[]
    List of plugins to install in the vault
  - Optionalthemes?: ThemeEntry[]
    List of themes to install in the vault
  - Optionalargs?: string[]
    CLI args to pass to Obsidian
  - OptionalspawnOptions?: SpawnOptions
    Options to pass to spawn
Returns Promise<{ proc: ChildProcess; configDir: string; vault?: string }>
The launched child process and the created tmpdirs
- Defined in launcher.ts:850

updateObsidianVersionInfos

updateObsidianVersionInfos(
original?: ObsidianVersionInfos,
__namedParameters?: { maxInstances?: number },
): Promise<ObsidianVersionInfos>
Updates the info obsidian-versions.json. The obsidian-versions.json file is used in other launcher commands and in wdio-obsidian-service to get metadata about Obsidian versions in one place such as minInstallerVersion and the internal electron version.
Parameters
- Optionaloriginal: ObsidianVersionInfos
- __namedParameters: { maxInstances?: number } = {}
Returns Promise<ObsidianVersionInfos>
- Defined in launcher.ts:892

isInCache

isInCache(type: "installer" | "app", version: string): Promise<boolean>
Returns true if the Obsidian version is already in the cache.
Parameters
- type: "installer" | "app"
  on of "app" or "installer"
- version: string
  Obsidian app/installer version
Returns Promise<boolean>
- Defined in launcher.ts:995

isAvailable

isAvailable(appVersion: string): Promise<boolean>
Returns true if we either have the credentials to download the version or it's already in cache. This is only relevant for Obsidian beta versions, as they require Obsidian insider credentials to download.
Parameters
- appVersion: string
  Obsidian app version
Returns Promise<boolean>
- Defined in launcher.ts:1014

Class default

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionalcacheDir?: string

OptionalversionsUrl?: string

OptionalcommunityPluginsUrl?: string

OptionalcommunityThemesUrl?: string

OptionalcacheDuration?: number

Returns default

Properties

ReadonlycacheDir

ReadonlyversionsUrl

ReadonlycommunityPluginsUrl

ReadonlycommunityThemesUrl

ReadonlycacheDuration

Methods

getVersions

Returns Promise<ObsidianVersionInfo[]>

getCommunityPlugins

Returns Promise<ObsidianCommunityPlugin[]>

getCommunityThemes

Returns Promise<ObsidianCommunityTheme[]>

resolveVersions

Parameters

Returns Promise<[string, string]>

getVersionInfo

Parameters

Returns Promise<ObsidianVersionInfo>

downloadInstaller

Parameters

Returns Promise<string>

downloadApp

Parameters

Returns Promise<string>

downloadChromedriver

Parameters

Returns Promise<string>

downloadPlugins

Parameters

Returns Promise<DownloadedPluginEntry[]>

downloadThemes

Parameters

Returns Promise<DownloadedThemeEntry[]>

installPlugins

Parameters

Returns Promise<void>

installThemes

Parameters

Returns Promise<void>

setupConfigDir

Parameters

appVersion: string

installerVersion: string

OptionalappPath?: string

Optionalvault?: string

Optionaldest?: string

Returns Promise<string>

setupVault

Parameters

vault: string

Optionalcopy?: boolean

Optionalplugins?: PluginEntry[]

Optionalthemes?: ThemeEntry[]

Returns Promise<string>

launch

Parameters

OptionalappVersion?: string

OptionalinstallerVersion?: string

Optionalcopy?: boolean

Optionalvault?: string

Optionalplugins?: PluginEntry[]

Optionalthemes?: ThemeEntry[]

Optionalargs?: string[]

OptionalspawnOptions?: SpawnOptions

Returns Promise<{ proc: ChildProcess; configDir: string; vault?: string }>

`Optional`cacheDir?: string

`Optional`versionsUrl?: string

`Optional`communityPluginsUrl?: string

`Optional`communityThemesUrl?: string

`Optional`cacheDuration?: number

`Readonly`cacheDir

`Readonly`versionsUrl

`Readonly`communityPluginsUrl

`Readonly`communityThemesUrl

`Readonly`cacheDuration

`Optional`appPath?: string

`Optional`vault?: string

`Optional`dest?: string

`Optional`copy?: boolean

`Optional`plugins?: PluginEntry[]

`Optional`themes?: ThemeEntry[]

`Optional`appVersion?: string

`Optional`installerVersion?: string

`Optional`copy?: boolean

`Optional`vault?: string

`Optional`plugins?: PluginEntry[]

`Optional`themes?: ThemeEntry[]

`Optional`args?: string[]

`Optional`spawnOptions?: SpawnOptions