> For the complete documentation index, see [llms.txt](https://yamipqm.gitbook.io/marked-links/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://yamipqm.gitbook.io/marked-links/guideofuse/cli.md).

# CLI

Ejecutable del módulo mdLinks.

![Logo de la librería en el CLI.](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97mAV5btJ1fcfUvj4w%2F-M97oTzKEQ1qhHmZJsUd%2FCaptura%20de%20pantalla%20de%202020-06-06%2003-46-47.png?alt=media\&token=eaca6d68-1460-462b-b474-f56d0e46517b)

El ejecutable se ejecuta de la siguiente manera a través de la terminal:

`md-links [options]`

Por ejemplo:

```
$ md-links ./some/example.md
```

En consola nos mostraría algo así:

![](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97mAV5btJ1fcfUvj4w%2F-M97pClhPqOlcYL7LhBZ%2FCaptura%20de%20pantalla%20de%202020-06-06%2003-46-47.png?alt=media\&token=10f841d5-078a-48b8-a3e8-85128d1a7bc3)

El comportamiento por defecto no debe validar si las URLs responden `ok` o `fail`, solo debe identificar el archivo markdown (a partir de la ruta que recibe como argumento), analizar el mismo e imprimir los links que vaya encontrando, junto con la ruta del archivo donde aparece y el texto dentro del link.

**Options:**

**--validate**

Si pasamos la opción `--validate`, el módulo realiza una petición HTTP para averiguar si el link funciona o no. Si el link resulta en una redirección a una URL que responde `ok`, entonces consideraremos el link como `ok`.

Por ejemplo:

```
$ md-links ./some/example.md --validate
```

Nos mostraría algo así:

![](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97mAV5btJ1fcfUvj4w%2F-M97q_YdcIPmZDve5lwE%2FCaptura%20de%20pantalla%20de%202020-06-06%2003-56-26.png?alt=media\&token=13d76b57-5dda-461b-bc0b-5bad383cc411)

Vemos que el *output* en este caso incluye la palabra `ok` o `fail` después de la URL, así como el status de la respuesta recibida de la petición HTTP a dicha URL.

**--stats**

Si pasamos la opción `--stats` el output (salida) será un texto con estadísticas básicas sobre los links.

```
$ md-links ./some/example.md --stats
```

Nos mostraría algo así:

![](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97shWAVvnTcExYC4es%2F-M98-D7iw_sr_bXAea8I%2FCaptura%20de%20pantalla%20de%202020-06-06%2004-40-22.png?alt=media\&token=b0410dba-99b9-4cb8-a4fc-8bdadf92e906)

También podemos combinar `--stats` y `--validate` para obtener estadísticas que necesiten de los resultados de la validación.

```
$ md-links ./some/example.md --stats --validate
```

```
$ md-links ./some/example.md --validate --stats
```

En ambos casos, nos mostraría algo así:

![](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97shWAVvnTcExYC4es%2F-M97zxCENpP4rFUb8wlH%2FCaptura%20de%20pantalla%20de%202020-06-06%2004-38-19.png?alt=media\&token=4b1add0b-3082-43d2-b361-3d1eaebf5850)

**Observación:**

La interfaz de línea de comando (CLI) realiza las siguientes validaciones:

![](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97shWAVvnTcExYC4es%2F-M97yrrer06PY9Px4YsO%2FCaptura%20de%20pantalla%20de%202020-06-06%2004-33-30.png?alt=media\&token=2cfe841c-9c2a-439c-b15c-3eed6209d172)

![](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97shWAVvnTcExYC4es%2F-M97zKFStKQlqASSIZDH%2FCaptura%20de%20pantalla%20de%202020-06-06%2004-36-28.png?alt=media\&token=3cf0d386-eb34-4ce7-8165-621ee3768046)

![](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97shWAVvnTcExYC4es%2F-M97zVRWCQpyZCybSYSQ%2FCaptura%20de%20pantalla%20de%202020-06-06%2004-37-16.png?alt=media\&token=ad570daf-da05-4a3b-a9bc-d1680335e3df)

![Las imágenes corresponden a las validaciones que realiza el CLI.](https://1264171553-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-M8qM33dX80Bd1NZItUf%2F-M97shWAVvnTcExYC4es%2F-M97y74P67inCFuptp3I%2FCaptura%20de%20pantalla%20de%202020-06-06%2004-31-10.png?alt=media\&token=4d68328b-3d13-440c-b16f-d6958b049408)