xmlim v0.1.0

xmlim (pronounced ex-em-el-im) is a CLI for generating diagrams of XML documents. XML is hierarchical, so a tree diagram is well suited for representing the structure of an XML document.

• Example Diagram
• Usage
• Commands
• Command Topics
• Credits

Example Diagram

Given the following XML:

<A>
  <B name="1">
    <C />
  </B>
  <B name="first_second_third_worst"/>
</A>

This diagram is generated:

Usage

$ npm install -g xmlim
$ xmlim COMMAND
running command...
$ xmlim (--version)
xmlim/0.1.0 linux-x64 node-v18.15.0
$ xmlim --help [COMMAND]
USAGE
  $ xmlim COMMAND
...

Commands

The xmlim CLI contains top level commands for basic usage and nested commands grouped by topic for additional functionality. The main command is xmlim gen and additional functionality is nested under the xmlim watch command.

Command Topics

• xmlim gen - Generate a diagram of a specified XML document
• xmlim help - Display help for xmlim.
• xmlim plugins - List installed plugins.
• xmlim watch - Watch a file or directory for changes and re-generate a new diagram

Credits

• CLI command processing and application scaffolded using oclif
• XML parsing using https://github.com/rgrove/parse-xml
• Diagram generation using https://www.nomnoml.com/