@shongcheng/drawio-export

Tool to export drawio pages using locally installed drawio-desktop, i.e draw.io.exe (Windows only)

• Usage
• Commands

Usage

$ npm install -g @shongcheng/drawio-export
$ drawio-export COMMAND
running command...
$ drawio-export (--version)
@shongcheng/drawio-export/1.0.1 win32-x64 node-v18.17.1
$ drawio-export --help [COMMAND]
USAGE
  $ drawio-export COMMAND
...

Commands

• drawio-export help [COMMANDS]
• drawio-export image <FILE> [FILE]...
• drawio-export plugins
• drawio-export plugins:install PLUGIN...
• drawio-export plugins:inspect PLUGIN...
• drawio-export plugins:install PLUGIN...
• drawio-export plugins:link PLUGIN
• drawio-export plugins:uninstall PLUGIN...
• drawio-export plugins:uninstall PLUGIN...
• drawio-export plugins:uninstall PLUGIN...
• drawio-export plugins update

drawio-export help [COMMANDS]

Display help for drawio-export.

USAGE
  $ drawio-export help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for drawio-export.

See code: @oclif/plugin-help

drawio-export image <FILE> [FILE]...

export pages as images

USAGE
  $ drawio-export image <FILE> [FILE]... --bash-bin <value> --drawio-desktop-bin <value> [-f png|jpg] [-o
    <value>]

ARGUMENTS
  <FILE> [FILE]...  one or more drawio files to be exported

FLAGS
  -f, --format=<option>         export format
                                <options: png|jpg>
  -o, --output-dir=<value>      [default: ./] output directory path
  --bash-bin=<value>            (required) path to Git bash.exe (alternatively, set env var: DRAWIO_EXPORT_BASH_BIN)
  --drawio-desktop-bin=<value>  (required) path to draw.io.exe  (alternatively, set env var:
                                DRAWIO_EXPORT_DRAWIO_DESKTOP_BIN)

DESCRIPTION
  export pages as images

EXAMPLES
  $ drawio-export image

See code: dist/commands/image.ts

drawio-export plugins

List installed plugins.

USAGE
  $ drawio-export plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ drawio-export plugins

See code: @oclif/plugin-plugins

drawio-export plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ drawio-export plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ drawio-export plugins add

EXAMPLES
  $ drawio-export plugins:install myplugin 

  $ drawio-export plugins:install https://github.com/someuser/someplugin

  $ drawio-export plugins:install someuser/someplugin

drawio-export plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ drawio-export plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ drawio-export plugins:inspect myplugin

See code: @oclif/plugin-plugins

drawio-export plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ drawio-export plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ drawio-export plugins add

EXAMPLES
  $ drawio-export plugins:install myplugin 

  $ drawio-export plugins:install https://github.com/someuser/someplugin

  $ drawio-export plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

drawio-export plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ drawio-export plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ drawio-export plugins:link myplugin

See code: @oclif/plugin-plugins

drawio-export plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ drawio-export plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ drawio-export plugins unlink
  $ drawio-export plugins remove

drawio-export plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ drawio-export plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ drawio-export plugins unlink
  $ drawio-export plugins remove

See code: @oclif/plugin-plugins

drawio-export plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ drawio-export plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ drawio-export plugins unlink
  $ drawio-export plugins remove

drawio-export plugins update

Update installed plugins.

USAGE
  $ drawio-export plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins