UNPKG

ovm

Version:

Obsidian Vaults Manager

815 lines 23.6 kB
{ "commands": { "config:init": { "aliases": [ "ci", "config init" ], "args": {}, "description": "Configure an ovm.json config file in user's home dir.", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "debug": { "char": "d", "description": "Enable debugging mode.", "name": "debug", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "description": "Enable timestamp in logs.", "name": "timestamp", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "name": "config", "required": false, "default": "/Users/mgh/ovm.json", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "config:init", "pluginAlias": "ovm", "pluginName": "ovm", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlags": { "debug": { "char": "d", "default": false, "description": "Enable debugging mode.", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "default": false, "description": "Enable timestamp in logs.", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "default": "/Users/mgh/ovm.json", "required": false, "input": [], "multiple": false, "type": "option" } }, "isESM": false, "relativePath": [ "dist", "commands", "config", "init.js" ] }, "plugins:install": { "aliases": [ "pi", "plugins install" ], "args": { "pluginId": { "description": "Specific Plugin ID to install", "name": "pluginId", "required": false } }, "description": "Install plugin(s) in specified vaults.", "examples": [ "<%= config.bin %> <%= command.id %> --path=/path/to/vaults", "<%= config.bin %> <%= command.id %> --path=/path/to/vaults/*/.obsidian", "<%= config.bin %> <%= command.id %> --path=/path/to/vaults/**/.obsidian", "<%= config.bin %> <%= command.id %> id" ], "flags": { "enable": { "char": "e", "description": "Enable all chosen plugins", "name": "enable", "allowNo": false, "type": "boolean" }, "debug": { "char": "d", "description": "Enable debugging mode.", "name": "debug", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "description": "Enable timestamp in logs.", "name": "timestamp", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "name": "config", "required": false, "default": "/Users/mgh/ovm.json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "char": "p", "description": "[default: detect from Obsidian config] Path or Glob pattern of vaults to install plugins.", "name": "path", "default": "", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "plugins:install", "pluginAlias": "ovm", "pluginName": "ovm", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlagsWithPath": { "debug": { "char": "d", "default": false, "description": "Enable debugging mode.", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "default": false, "description": "Enable timestamp in logs.", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "default": "/Users/mgh/ovm.json", "required": false, "input": [], "multiple": false, "type": "option" }, "path": { "char": "p", "description": "[default: detect from Obsidian config] Path or Glob pattern of vaults to install plugins.", "default": "", "input": [], "multiple": false, "type": "option" } }, "commonFlags": { "debug": { "char": "d", "default": false, "description": "Enable debugging mode.", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "default": false, "description": "Enable timestamp in logs.", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "default": "/Users/mgh/ovm.json", "required": false, "input": [], "multiple": false, "type": "option" }, "path": { "char": "p", "description": "[default: detect from Obsidian config] Path or Glob pattern of vaults to install plugins.", "default": "", "input": [], "multiple": false, "type": "option" } }, "isESM": false, "relativePath": [ "dist", "commands", "plugins", "install.js" ] }, "plugins:prune": { "aliases": [ "pp", "plugins prune" ], "args": {}, "description": "Prune existing plugin(s) from vaults that are unspecified in the config file.", "examples": [ "<%= config.bin %> <%= command.id %> --path=/path/to/vaults", "<%= config.bin %> <%= command.id %> --path=/path/to/vaults/*/.obsidian", "<%= config.bin %> <%= command.id %> --path=/path/to/vaults/**/.obsidian" ], "flags": { "debug": { "char": "d", "description": "Enable debugging mode.", "name": "debug", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "description": "Enable timestamp in logs.", "name": "timestamp", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "name": "config", "required": false, "default": "/Users/mgh/ovm.json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "char": "p", "description": "[default: detect from Obsidian config] Path or Glob pattern of vaults to install plugins.", "name": "path", "default": "", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "plugins:prune", "pluginAlias": "ovm", "pluginName": "ovm", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlagsWithPath": { "debug": { "char": "d", "default": false, "description": "Enable debugging mode.", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "default": false, "description": "Enable timestamp in logs.", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "default": "/Users/mgh/ovm.json", "required": false, "input": [], "multiple": false, "type": "option" }, "path": { "char": "p", "description": "[default: detect from Obsidian config] Path or Glob pattern of vaults to install plugins.", "default": "", "input": [], "multiple": false, "type": "option" } }, "commonFlags": { "debug": { "char": "d", "default": false, "description": "Enable debugging mode.", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "default": false, "description": "Enable timestamp in logs.", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "default": "/Users/mgh/ovm.json", "required": false, "input": [], "multiple": false, "type": "option" }, "path": { "char": "p", "description": "[default: detect from Obsidian config] Path or Glob pattern of vaults to install plugins.", "default": "", "input": [], "multiple": false, "type": "option" } }, "isESM": false, "relativePath": [ "dist", "commands", "plugins", "prune.js" ] }, "plugins:uninstall": { "aliases": [ "pu", "plugins uninstall" ], "args": { "pluginId": { "description": "Specific Plugin ID to uninstall", "name": "pluginId", "required": false } }, "description": "Uninstall plugin(s) from vaults.", "examples": [ "<%= config.bin %> <%= command.id %> --path=/path/to/vaults", "<%= config.bin %> <%= command.id %> --path=/path/to/vaults/*/.obsidian", "<%= config.bin %> <%= command.id %> --path=/path/to/vaults/**/.obsidian", "<%= config.bin %> <%= command.id %> id" ], "flags": { "debug": { "char": "d", "description": "Enable debugging mode.", "name": "debug", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "description": "Enable timestamp in logs.", "name": "timestamp", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "name": "config", "required": false, "default": "/Users/mgh/ovm.json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "char": "p", "description": "[default: detect from Obsidian config] Path or Glob pattern of vaults to install plugins.", "name": "path", "default": "", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "plugins:uninstall", "pluginAlias": "ovm", "pluginName": "ovm", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlagsWithPath": { "debug": { "char": "d", "default": false, "description": "Enable debugging mode.", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "default": false, "description": "Enable timestamp in logs.", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "default": "/Users/mgh/ovm.json", "required": false, "input": [], "multiple": false, "type": "option" }, "path": { "char": "p", "description": "[default: detect from Obsidian config] Path or Glob pattern of vaults to install plugins.", "default": "", "input": [], "multiple": false, "type": "option" } }, "commonFlags": { "debug": { "char": "d", "default": false, "description": "Enable debugging mode.", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "default": false, "description": "Enable timestamp in logs.", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "default": "/Users/mgh/ovm.json", "required": false, "input": [], "multiple": false, "type": "option" }, "path": { "char": "p", "description": "[default: detect from Obsidian config] Path or Glob pattern of vaults to install plugins.", "default": "", "input": [], "multiple": false, "type": "option" } }, "isESM": false, "relativePath": [ "dist", "commands", "plugins", "uninstall.js" ] }, "vaults:run": { "aliases": [ "r", "run", "vr", "vaults run" ], "args": { "command": { "default": "", "description": "Command to run and use specified vaults with each execution.", "name": "command", "required": true } }, "description": "Run a shell command on selected vaults (using Node.js child_process).\nDisclaimer: Any input containing shell metacharacters may be used to trigger arbitrary command execution, using of this command is at risk of command's caller.", "examples": [ "<%= config.bin %> <%= command.id %> --path=/path/to/vaults", "<%= config.bin %> <%= command.id %> --path=/path/to/vaults/*/.obsidian --output=json", "<%= config.bin %> <%= command.id %> --path=/path/to/vaults/**/.obsidian --output=json --unescape=false", "<%= config.bin %> <%= command.id %> --output=json --async=false", "<%= config.bin %> <%= command.id %> --output=json --silent=true", "<%= config.bin %> <%= command.id %> --output=json --cwd=/path/to/vaults" ], "flags": { "output": { "char": "o", "description": "Display the output with a specific transformer.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json" ], "type": "option" }, "unescape": { "char": "u", "description": "Unescape special characters in a command to run as a single command.", "name": "unescape", "allowNo": false, "type": "boolean" }, "async": { "char": "a", "description": "Run the command in parallel on the vault(s).", "name": "async", "allowNo": false, "type": "boolean" }, "silent": { "char": "s", "description": "Silent on results of the custom command on vault(s).", "name": "silent", "allowNo": false, "type": "boolean" }, "cwd": { "char": "w", "description": "[default: vault path] Set working directory for custom command.", "name": "cwd", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "debug": { "char": "d", "description": "Enable debugging mode.", "name": "debug", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "description": "Enable timestamp in logs.", "name": "timestamp", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "name": "config", "required": false, "default": "/Users/mgh/ovm.json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "char": "p", "description": "[default: detect from Obsidian config] Path or Glob pattern of vaults to install plugins.", "name": "path", "default": "", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "vaults:run", "pluginAlias": "ovm", "pluginName": "ovm", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlagsWithPath": { "debug": { "char": "d", "default": false, "description": "Enable debugging mode.", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "default": false, "description": "Enable timestamp in logs.", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "default": "/Users/mgh/ovm.json", "required": false, "input": [], "multiple": false, "type": "option" }, "path": { "char": "p", "description": "[default: detect from Obsidian config] Path or Glob pattern of vaults to install plugins.", "default": "", "input": [], "multiple": false, "type": "option" } }, "commonFlags": { "debug": { "char": "d", "default": false, "description": "Enable debugging mode.", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "default": false, "description": "Enable timestamp in logs.", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "default": "/Users/mgh/ovm.json", "required": false, "input": [], "multiple": false, "type": "option" }, "path": { "char": "p", "description": "[default: detect from Obsidian config] Path or Glob pattern of vaults to install plugins.", "default": "", "input": [], "multiple": false, "type": "option" } }, "isESM": false, "relativePath": [ "dist", "commands", "vaults", "run.js" ] }, "reports:stats": { "aliases": [ "rs", "reports stats" ], "args": {}, "description": "Statistics of vaults and installed plugins.", "examples": [ "<%= config.bin %> <%= command.id %> --path=/path/to/vaults", "<%= config.bin %> <%= command.id %> --path=/path/to/vaults/*/.obsidian", "<%= config.bin %> <%= command.id %> --path=/path/to/vaults/**/.obsidian" ], "flags": { "output": { "char": "o", "description": "Display the output with a specific transformer.", "name": "output", "default": "table", "hasDynamicHelp": false, "multiple": false, "options": [ "table", "json" ], "type": "option" }, "debug": { "char": "d", "description": "Enable debugging mode.", "name": "debug", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "description": "Enable timestamp in logs.", "name": "timestamp", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "name": "config", "required": false, "default": "/Users/mgh/ovm.json", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "path": { "char": "p", "description": "[default: detect from Obsidian config] Path or Glob pattern of vaults to install plugins.", "name": "path", "default": "", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "reports:stats", "pluginAlias": "ovm", "pluginName": "ovm", "pluginType": "core", "strict": true, "enableJsonFlag": false, "commonFlagsWithPath": { "debug": { "char": "d", "default": false, "description": "Enable debugging mode.", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "default": false, "description": "Enable timestamp in logs.", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "default": "/Users/mgh/ovm.json", "required": false, "input": [], "multiple": false, "type": "option" }, "path": { "char": "p", "description": "[default: detect from Obsidian config] Path or Glob pattern of vaults to install plugins.", "default": "", "input": [], "multiple": false, "type": "option" } }, "commonFlags": { "debug": { "char": "d", "default": false, "description": "Enable debugging mode.", "allowNo": false, "type": "boolean" }, "timestamp": { "char": "t", "default": false, "description": "Enable timestamp in logs.", "allowNo": false, "type": "boolean" }, "config": { "char": "c", "description": "Path to the config file.", "default": "/Users/mgh/ovm.json", "required": false, "input": [], "multiple": false, "type": "option" }, "path": { "char": "p", "description": "[default: detect from Obsidian config] Path or Glob pattern of vaults to install plugins.", "default": "", "input": [], "multiple": false, "type": "option" } }, "isESM": false, "relativePath": [ "dist", "commands", "reports", "stats.js" ] } }, "version": "0.6.8" }