Skip to content

ElectronSettings

Unofficial

Settings for the app’s login item.

Import:

import type { ElectronSettings } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface ElectronSettings

Properties

Property Type Description
args? string[] The command-line arguments to pass to the executable. Windows only.
enabled? boolean true to change the startup approved registry key and enable/disable the app in Task Manager and Windows settings. Windows only.
name? string Value name to write into registry. Defaults to the app's AppUserModelId. Windows only.
openAsHidden? boolean true to open the app as hidden. Not available on MAS builds. macOS only.
openAtLogin? boolean true to open the app at login, false to remove the app as a login item.
path? string The executable to launch at login. Windows only.