npm package: @germansan2002/mysql-generator
Description: A CLI tool for generating MySQL connection and entity files
Author: German Sancho Miñano
Latest version: 1.0.0

Aquí tienes el archivo `readme.md` actualizado para incluir la información sobre cómo agregar los comandos disponibles al `package.json` del proyecto que importa el paquete:

```markdown
# mysql-generator

`mysql-generator` es una herramienta CLI para generar archivos de conexión y modelos para trabajar con bases de datos MySQL en proyectos Node.js.

## Comandos disponibles

```bash
Comandos disponibles:
  connect         Conecta a un proveedor de base de datos y prueba la conexión.
  tables          Obtiene la lista de tablas de una base de datos determinada.
  generate, g     Genera archivos necesarios para realizar transacciones con la base de datos:
                  --connection Genera el archivo de conexión.
                  --entities    Genera los modelos basados en las tablas de la base de datos.
  stats           Obtiene estadísticas sobre el sistema operativo subyacente y la utilización de recursos:
                  --db        Obtiene datos estadísticos de la base de datos definida en el archivo de configuración.
  help            Muestra los comandos disponibles de la CLI.
```

## Instalación

Para instalar el paquete, usa el siguiente comando:

```bash
npm install mysql-generator
```

## Uso

### Archivo de configuración

Para utilizar los comandos, debes proporcionar un archivo de configuración `.json` utilizando el atributo `--config`. Aquí tienes un ejemplo de archivo de configuración:

```json
{
    "server": "localhost",
    "port": 3306,
    "user": {
      "name": "root",
      "password": "123456789"
    },
    "database": "examenfinal2023",
    "dest": "src/server/mysql"
}
```

### Ejemplos de comandos

#### Conectar a una base de datos

```bash
mysql-generator connect --config ./path/to/config.json
```

#### Obtener la lista de tablas

```bash
mysql-generator tables --config ./path/to/config.json
```

#### Generar archivos

```bash
mysql-generator generate --connection --config ./path/to/config.json
mysql-generator generate --entities --config ./path/to/config.json
```

#### Obtener estadísticas del sistema

```bash
mysql-generator stats --config ./path/to/config.json
mysql-generator stats --db --config ./path/to/config.json
```

#### Mostrar la ayuda

```bash
mysql-generator help
```

### Agregar comandos al `package.json`

Puedes agregar los comandos disponibles al `package.json` de tu proyecto para facilitar su uso. Aquí tienes un ejemplo de cómo hacerlo:

```json
{
  "scripts": {
    "connect": "mysql-generator connect --config ./path/to/config.json",
    "tables": "mysql-generator tables --config ./path/to/config.json",
    "generate:connection": "mysql-generator generate --connection --config ./path/to/config.json",
    "generate:entities": "mysql-generator generate --entities --config ./path/to/config.json",
    "stats": "mysql-generator stats --config ./path/to/config.json",
    "stats:db": "mysql-generator stats --db --config ./path/to/config.json",
    "help": "mysql-generator help"
  }
}
```

Ahora puedes ejecutar los comandos directamente desde npm:

```bash
npm run connect
npm run tables
npm run generate:connection
npm run generate:entities
npm run stats
npm run stats:db
npm run help
```

## Dependencias

Este proyecto utiliza las siguientes dependencias:

- [fs](https://www.npmjs.com/package/fs) ^0.0.1-security
- [mysql2](https://www.npmjs.com/package/mysql2) ^3.10.1
- [reflect-metadata](https://www.npmjs.com/package/reflect-metadata) ^0.2.2
- [typeorm](https://www.npmjs.com/package/typeorm) ^0.3.20
- [yargs](https://www.npmjs.com/package/yargs) ^17.7.2

## Contribuir

Si deseas contribuir al proyecto, por favor abre un issue o envía un pull request en el repositorio de GitHub.

## Licencia

Este proyecto está bajo la licencia MIT.
```

Este archivo `readme.md` proporciona una guía completa sobre cómo usar el paquete, incluyendo la adición de los comandos al `package.json` del proyecto que lo importa.