Obsidian Plugin Generator

For generating the obsidian plugin project.

Install

npm i -g obsidian-plugin-generator

Usage

Usage: opg [options]

Options:
  -v, --version  output the version number
  -i, --init     init an obsidian plugin project
  -H, --https    clone the obsidian-sample-plugin from https://github.com/obsidianmd/obsidian-sample-plugin.git.
  -h, --help     display help for command

Properties

Property	Type	Required	Description
author	string	Yes	The plugin author's name.
description	string	Yes	The long description of your plugin.
id	string	Yes	The ID of your plugin.
name	string	Yes	The display name of your plugin.
isDesktopOnly	boolean	No	Whether your plugin uses NodeJS or Electron APIs. The default value is false.
minAppVersion	string	No	The minimum required Obsidian version for your plugin. The default value is '0.15.0'.
version	string	No	The version of your plugin. The default value is '1.0.0'.
authorUrl	string	No	A URL to your own website.
fundingUrl	string	No	Funding url.