# vlink-monorepo

> A CLI Tool to help you to manage your linked VTEX IO components on monorepo projects

Latest version **0.0.8** (published 2022-05-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install vlink-monorepo
pnpm add vlink-monorepo
yarn add vlink-monorepo
bun add vlink-monorepo
```

Provides the command `vlink`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2022-05-16 |
| First published | 2022-04-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 4.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | CoutoDev |
| Maintainers | coutodev |

## Links

- npm: https://www.npmjs.com/package/vlink-monorepo
- Repository: https://github.com/CoutoDev/vlink-monorepo
- Homepage: https://github.com/CoutoDev/vlink-monorepo#readme
- Issues: https://github.com/CoutoDev/vlink-monorepo/issues
- npm.io page: https://npm.io/package/vlink-monorepo

## Dependencies (10)

- [chalk](https://npm.io/package/chalk.md) ^5.0.1
- [figlet](https://npm.io/package/figlet.md) ^1.5.2
- [global](https://npm.io/package/global.md) ^4.4.0
- [nodemon](https://npm.io/package/nodemon.md) ^2.0.15
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.5
- [inquirer](https://npm.io/package/inquirer.md) ^8.2.3
- [cli-table](https://npm.io/package/cli-table.md) ^0.3.11
- [commander](https://npm.io/package/commander.md) ^9.2.0
- [concurrently](https://npm.io/package/concurrently.md) ^7.1.0
- [vlink-monorepo](https://npm.io/package/vlink-monorepo.md) ^0.0.5

## Recent versions

- 0.0.8 (latest) — 2022-05-16
- 0.0.7 — 2022-05-13
- 0.0.6 — 2022-05-13
- 0.0.5 — 2022-05-13
- 0.0.4 — 2022-04-27
- 0.0.3 — 2022-04-27
- 0.0.2 — 2022-04-27
- 0.0.1 — 2022-04-27

## README

# VLINK-MONOREPO
## A CLI tool that helps you to link your VTEX IO Components/Apps

<mark>Besides the name, this tool also works if you have multiple repos of the same project on the root folder that you want to run vlink.</mark>

### Install

`npm i -g vlink-monorepo`

Or

`yarn add global vlink-monorepo`

<mark>It's important that you have installed Yarn and globally installed version of 'concurrently' package to this tool to work.</mark>

### Install Yarn
`npm i -g yarn`

### Install concurrently
`yarn add global concurrently`

### Usage

Commands:
```
  link [componentFolder]  Link VTEX IO components
  fix [componentFolder]   Unlink and Link VTEX IO components
  help [command]          display help for command
```
### Examples:

`vlink link` -> Will run over all projects inside the current folder (basically sets the path like ".") and run vtex link if the manifest.json file exists on project.

`vlink fix` -> Same as link, but will unlink the project and then link again.

### You can also specify the project you want to link:
`vlink link customComponent`

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