npm package: @mrdnz/patron
Description: CLI tool for generating design-patterns, data-structures and algorithms
Author: Maarten Zwitser
Latest version: 0.0.14-beta.1

# patron

CLI tool for generating design patterns

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/patron.svg)](https://npmjs.org/package/patron)
[![Codecov](https://codecov.io/gh/MRDNZ/patron/branch/master/graph/badge.svg)](https://codecov.io/gh/MRDNZ/patron)
[![Downloads/week](https://img.shields.io/npm/dw/patron.svg)](https://npmjs.org/package/patron)
[![License](https://img.shields.io/npm/l/patron.svg)](https://github.com/MRDNZ/patron/blob/master/package.json)

<!-- toc -->

- [patron](#patron)
- [Usage](#usage)
- [Commands](#commands)
  <!-- tocstop -->

# Usage

<!-- usage -->

```sh-session
$ npm install -g @mrdnz/patron
$ patron COMMAND
running command...
$ patron (-v|--version|version)
@mrdnz/patron/0.0.14-alpha.7 win32-x64 node-v14.9.0
$ patron --help [COMMAND]
USAGE
  $ patron COMMAND
...
```

<!-- usagestop -->

# Commands

<!-- commands -->

- [`patron algorithms [COMMAND]`](#patron-algorithms-command)
- [`patron algorithms:generate [PATTERN] [NAME]`](#patron-algorithmsgenerate-pattern-name)
- [`patron data-structures [COMMAND]`](#patron-data-structures-command)
- [`patron data-structures:generate [PATTERN] [NAME]`](#patron-data-structuresgenerate-pattern-name)
- [`patron functional [COMMAND]`](#patron-functional-command)
- [`patron functional:generate [PATTERN] [NAME]`](#patron-functionalgenerate-pattern-name)
- [`patron help [COMMAND]`](#patron-help-command)
- [`patron object-oriented [COMMAND]`](#patron-object-oriented-command)
- [`patron object-oriented:generate [PATTERN] [NAME]`](#patron-object-orientedgenerate-pattern-name)

## `patron algorithms [COMMAND]`

describe the command here

```
USAGE
  $ patron algorithms [COMMAND]

OPTIONS
  -c, --config=config  patron.json location
  -h, --help           show CLI help
  -l, --list           show patterns

ALIASES
  $ patron a
```

_See code: [src\commands\algorithms\index.ts](https://github.com/MRDNZ/patron/blob/v0.0.14-alpha.7/src\commands\algorithms\index.ts)_

## `patron algorithms:generate [PATTERN] [NAME]`

describe the command here

```
USAGE
  $ patron algorithms:generate [PATTERN] [NAME]

OPTIONS
  -c, --config=config  patron.json location
  -h, --help           show CLI help
  -l, --list           show patterns
  -x, --examples       generate examples

ALIASES
  $ patron a:g
```

_See code: [src\commands\algorithms\generate.ts](https://github.com/MRDNZ/patron/blob/v0.0.14-alpha.7/src\commands\algorithms\generate.ts)_

## `patron data-structures [COMMAND]`

describe the command here

```
USAGE
  $ patron data-structures [COMMAND]

OPTIONS
  -c, --config=config  patron.json location
  -h, --help           show CLI help
  -l, --list           show patterns

ALIASES
  $ patron ds
```

_See code: [src\commands\data-structures\index.ts](https://github.com/MRDNZ/patron/blob/v0.0.14-alpha.7/src\commands\data-structures\index.ts)_

## `patron data-structures:generate [PATTERN] [NAME]`

describe the command here

```
USAGE
  $ patron data-structures:generate [PATTERN] [NAME]

OPTIONS
  -c, --config=config  patron.json location
  -h, --help           show CLI help
  -l, --list           show patterns
  -x, --examples       generate examples

ALIASES
  $ patron ds:g
```

_See code: [src\commands\data-structures\generate.ts](https://github.com/MRDNZ/patron/blob/v0.0.14-alpha.7/src\commands\data-structures\generate.ts)_

## `patron functional [COMMAND]`

describe the command here

```
USAGE
  $ patron functional [COMMAND]

OPTIONS
  -c, --config=config  patron.json location
  -h, --help           show CLI help
  -l, --list           show patterns

ALIASES
  $ patron f
```

_See code: [src\commands\functional\index.ts](https://github.com/MRDNZ/patron/blob/v0.0.14-alpha.7/src\commands\functional\index.ts)_

## `patron functional:generate [PATTERN] [NAME]`

describe the command here

```
USAGE
  $ patron functional:generate [PATTERN] [NAME]

OPTIONS
  -c, --config=config  patron.json location
  -h, --help           show CLI help
  -l, --list           show patterns
  -x, --examples       generate examples

ALIASES
  $ patron f:g
```

_See code: [src\commands\functional\generate.ts](https://github.com/MRDNZ/patron/blob/v0.0.14-alpha.7/src\commands\functional\generate.ts)_

## `patron help [COMMAND]`

display help for patron

```
USAGE
  $ patron help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.1/src\commands\help.ts)_

## `patron object-oriented [COMMAND]`

describe the command here

```
USAGE
  $ patron object-oriented [COMMAND]

OPTIONS
  -c, --config=config  patron.json location
  -h, --help           show CLI help
  -l, --list           show patterns

ALIASES
  $ patron oo
```

_See code: [src\commands\object-oriented\index.ts](https://github.com/MRDNZ/patron/blob/v0.0.14-alpha.7/src\commands\object-oriented\index.ts)_

## `patron object-oriented:generate [PATTERN] [NAME]`

describe the command here

```
USAGE
  $ patron object-oriented:generate [PATTERN] [NAME]

OPTIONS
  -c, --config=config  patron.json location
  -h, --help           show CLI help
  -l, --list           show patterns
  -x, --examples       generate examples

ALIASES
  $ patron oo:g
```

_See code: [src\commands\object-oriented\generate.ts](https://github.com/MRDNZ/patron/blob/v0.0.14-alpha.7/src\commands\object-oriented\generate.ts)_

<!-- commandsstop -->