# @strongeleeroy/teamr

> Random team generator

Latest version **1.0.0** (published 2018-12-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @strongeleeroy/teamr
pnpm add @strongeleeroy/teamr
yarn add @strongeleeroy/teamr
bun add @strongeleeroy/teamr
```

Provides the command `teamr`.

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-12-20 |
| First published | 2018-12-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 33.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Gorka Hernandez Estomba |
| Maintainers | strongeleeroy |
| Keywords | random, teams, team, generator, nodejs |

## Links

- npm: https://www.npmjs.com/package/@strongeleeroy/teamr
- Repository: https://github.com/StrongeLeeroy/teamr
- Homepage: https://github.com/StrongeLeeroy/teamr#readme
- Issues: https://github.com/StrongeLeeroy/teamr/issues
- npm.io page: https://npm.io/package/@strongeleeroy/teamr

## Dependencies (6)

- [colors](https://npm.io/package/colors.md) ^1.3.3
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.12.0
- [typescript](https://npm.io/package/typescript.md) ^3.2.2
- [@types/node](https://npm.io/package/@types/node.md) ^10.12.18
- [@types/colors](https://npm.io/package/@types/colors.md) ^1.2.1
- [@types/js-yaml](https://npm.io/package/@types/js-yaml.md) ^3.11.3

## Recent versions

- 1.0.0 (latest) — 2018-12-20

## README

# Teamr

A random team generator CLI tool.

## Installation & Usage

Install **teamr** globally by running:

`npm install -g @strongeleeroy/teamr`

Then, use it from the command line:

```sh
teamr --config teams.yaml
```

## Configuration (teams.yaml)

The initial teams configuration is done in YAML and must contain the number of desired teams and a list of people:

```yaml
teams: 2
people:
- Luisa
- Carlos
- Jamika
- Buck
- Steven
- Christen
- Sally
- Margene
- Ashlie
```

## Debug logs

Display debug logs by addind the `--debug` flag to the `teamr` command:

```sh
teamr --config ./teams.yaml --debug
```

Output:
```sh
[INFO] Generating 2 teams with a total of 9 people...

>---------- Viable Chinchillas ----------<
  =>  Steven
  =>  Margene
  =>  Ashlie
  =>  Christen
  =>  Carlos
>----------------------------------------<


>---------- Braided Leopards ----------<
  =>  Sally
  =>  Buck
  =>  Jamika
  =>  Luisa
>--------------------------------------<

[OK] Done in 11ms.
```

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