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

# CLI md-links

@omairapalacios/md-links \<path> {options}

* Expone ejecutable `md-links`
* Se ejecuta sin errores / output esperado.
* El ejecutable implementa `--validate`.
* El ejecutable implementa `--stats`.
* El ejecutable implementa `--validate` y `--stats` juntos.

### Ejecute a través del terminal:

`md-links <path-to-file>`{options}&#x20;

**1 - CASO : md-links \<path>**  *Retorna  los links encontrados en la ruta dada, la ruta donde fueron hallados y texto que los identificaba.*

* *path-to-file* : ruta absoluta ó relativa.
* *options.validate :* predeterminado *false.*
* *options.stats :* predeterminado *false.*

```
$ md-links ./some/example.md
./some/example.md https://jestjs.io/ Testing con jest
./some/example.md https://es.reactjs.org/ Librería
./some/example.md https://es.wikipedia.org/ Wikipedia
```

**2 - CASO : md-links \<path> --validate**  *Retorna  los links encontrados en la ruta, dada, la ruta donde fueron hallados, el texto que los identificaba y el código de respuesta HTTP,  seguido de un mensaje .*

* *path-to-file* : ruta absoluta ó relativa.
* *options.validate :* true
* *options.stats:* predeterminado *false.*

```
$ md-links ./some/example.md --validate
/some/example.md https://jestjs.io/ 200 Ok Testing con jest 
./some/example.md https://es.reactjs.org/ 200 Ok Librería 
./some/example.md https://es.wikipedia.org/ 400 Fail Wikipedia
```

**3 - CASO : md-links \<path> --stats**  *Retorna estadisticas  básicas según los links encontrados: Total de links encontrados, y total de links únicos.*

* *path-to-file* : ruta absoluta ó relativa.
* *options.validate :* predeterminado *false.*
* *options.stats: true*

```
$ md-links ./some/example.md --stats
Total: 3
Unique: 3
```

**3 - CASO : md-links \<path> --stats --validate**  *Retorna estadisticas  básicas según los links encontrados y el resultado de la petición HTTP: Total de links encontrados, total de links únicos y links sin respuesta.*

* *path-to-file* : ruta absoluta ó relativa.
* *options.validate :* tru&#x65;*.*
* *options.stats: true*

```
$ md-links ./some/example.md --stats
Total: 3
Unique: 3
broken: 1
```