obsidian-plugin-cli v0.8.2-canary.62.dc36fc8.0

obsidian-plugin-cli

A CLI tool to make building an obsidian plugin simple

NOTE This is alpha software and there will be breaking changes. It'll be stable once 1.0 is released.

• obsidian-plugin-cli
• Usage
• Commands

Usage

$ npm install -g obsidian-plugin-cli
$ obsidian-plugin COMMAND
running command...
$ obsidian-plugin (-v|--version|version)
obsidian-plugin-cli/0.8.2-canary.62.dc36fc8.0 linux-x64 node-v14.19.0
$ obsidian-plugin --help [COMMAND]
USAGE
  $ obsidian-plugin COMMAND
...

Commands

• obsidian-plugin build [ENTRYPOINT]
• obsidian-plugin dev [ENTRYPOINT]
• obsidian-plugin help [COMMAND]
• obsidian-plugin install [PLUGIN]

obsidian-plugin build [ENTRYPOINT]

builds plugin for release

USAGE
  $ obsidian-plugin build [ENTRYPOINT]

OPTIONS
  -S, --with-stylesheet=with-stylesheet  include a stylesheet
  -e, --esbuild-config=esbuild-config    path to a config file containing esbuild options to apply to the build
  -h, --help                             show CLI help
  -o, --output-dir=output-dir            [default: dist] path to write build output to

See code: src/commands/build.ts

obsidian-plugin dev [ENTRYPOINT]

builds in watch mode and copies output to a specified vault for testing

USAGE
  $ obsidian-plugin dev [ENTRYPOINT]

OPTIONS
  -S, --with-stylesheet=with-stylesheet  include a stylesheet
  -e, --esbuild-config=esbuild-config    path to a JSON file over esbuild options to enhance/override the current build
  -h, --help                             show CLI help
  -n, --no-prompts                       disable prompting for user input
  -v, --vault-path=vault-path            path to the obsidian vault you want to develop in

DESCRIPTION
  If --vault-path is not specified, this command will try to intelligently determine where your vaults are located.
  If it's able to locate your vaults, you'll be given the option to select which vault you'd like to develop against. 
  If, however, --no-prompts is passed it will assume the last opened vault (if one is found) will be the vault to 
  develop 
  against. If that's not the behavior you desire, ensure to pass the explicit path to the vault you want to develop 
  against 
  with --vault-path.

See code: src/commands/dev.ts

obsidian-plugin help [COMMAND]

display help for obsidian-plugin

USAGE
  $ obsidian-plugin help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

obsidian-plugin install [PLUGIN]

installs a plugin from obsidian's community registry or directly from github

USAGE
  $ obsidian-plugin install [PLUGIN]

OPTIONS
  -h, --help         show CLI help
  -v, --vault=vault  the vault in which to install the plugin

DESCRIPTION
  To install a plugin from the registry just pass its name

     obsidian-plugin install my-plugin

  To install a plugin from github pass a URL or the owner/repository slugs from the end of the url

     obsidian-plugin install me/my-plugin
     obsidian-plugin install https://github.com/me/my-plugin

See code: src/commands/install.ts