WDIO Obsidian Service
    Preparing search index...

    Type Alias PluginEntry

    PluginEntry:
        | string
        | { enabled?: boolean; path: string }
        | { enabled?: boolean; repo: string; version?: string }
        | { enabled?: boolean; id: string; version?: string }

    A plugin to install. Can be a simple string path to the local plugin to install, or an object. If an object set one of:

    • path to install a local plugin
    • repo to install a plugin from github
    • id to install a community plugin

    You can also pass enabled: false to install the plugin, but start it disabled by default.

    Type declaration

    • string
    • { enabled?: boolean; path: string }
      • Optionalenabled?: boolean

        Set false to install the plugin but start it disabled. Default true.

      • path: string

        Path on disk to the plugin to install.

    • { enabled?: boolean; repo: string; version?: string }
      • Optionalenabled?: boolean

        Set false to install the plugin but start it disabled. Default true.

      • repo: string

        Github repo of the plugin to install, e.g. "some-user/some-plugin".

      • Optionalversion?: string

        Version of the plugin to install. Defaults to latest.

    • { enabled?: boolean; id: string; version?: string }
      • Optionalenabled?: boolean

        Set false to install the plugin but start it disabled. Default true.

      • id: string

        Plugin ID to install from Obsidian community plugins.

      • Optionalversion?: string

        Version of the plugin to install. Defaults to latest.

    Settings