# xmlim

> Generates diagrams of XML documents

Latest version **0.1.0** (published 2023-09-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install xmlim
pnpm add xmlim
yarn add xmlim
bun add xmlim
```

Provides the command `xmlim`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2023-09-18 |
| First published | 2023-09-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 5 |
| Unpacked size | 24.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | William Wedler |
| Maintainers | zflat |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/xmlim
- Repository: https://github.com/zflat/xmlim
- Issues: https://github.com/zflat/xmlim/issues
- npm.io page: https://npm.io/package/xmlim

## Dependencies (5)

- [nomnoml](https://npm.io/package/nomnoml.md) ^1.6.2
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^2
- [@rgrove/parse-xml](https://npm.io/package/@rgrove/parse-xml.md) ^4.1.0
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^5
- [@oclif/plugin-plugins](https://npm.io/package/@oclif/plugin-plugins.md) ^2.4.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2023-09-18

## README

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.

<!-- toc -->
* [Example Diagram](#example-diagram)
* [Usage](#usage)
* [Commands](#commands)
* [Command Topics](#command-topics)
* [Credits](#credits)
<!-- tocstop -->

# Example Diagram

Given the following XML:

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

This diagram is generated:

![example_diagram](test/examples/example1.svg)

# Usage

<!-- usage -->
```sh-session
$ 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
...
```
<!-- usagestop -->

# 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`](docs/gen.md) and additional functionality is nested under the [`xmlim watch`](docs/watch.md) command.

<!-- commands -->
# Command Topics

* [`xmlim gen`](docs/gen.md) - Generate a diagram of a specified XML document
* [`xmlim help`](docs/help.md) - Display help for xmlim.
* [`xmlim plugins`](docs/plugins.md) - List installed plugins.
* [`xmlim watch`](docs/watch.md) - Watch a file or directory for changes and re-generate a new diagram

<!-- commandsstop -->

# Credits

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

---
_Source: https://npm.io/package/xmlim · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._