Skip to content

Latest commit

 

History

History
109 lines (80 loc) · 3 KB

README.md

File metadata and controls

109 lines (80 loc) · 3 KB

Contributors Forks Stargazers Issues MIT License


loctry

This is a CLI for improve the local library testing experience

Report Bug · Request Feature

About The Project

This is a CLI for improve the local library testing experience. Under the hood this CLI uses npm pack for generate a tarball equals the sended to the npm registry to allow you test if the proejct is correcty configurated.

NOTE: this requires at least NPM 7+

Usage

Install the loctry globaly

npm install -g loctry

Enter in your pacakge directory and run

loctry publish

NOTE: This command needs to be run in the same dir as the package.json

This command will pack and send your package tarball to the .loctry folder to be avaiable to be installed in others projects.

NOTE: Do not modify .loctry dir manually. This is an internal API

To install the package enter in the project directory and run

loctry install <package-name>

This command will install your local package in the current project

Commands

Publish

Pack and send your package tarball to the .loctry folder to be avaiable to be installed in others projects.

Unpublish

Remove your package tarball from the .loctry folder. The package cannot be installed in others projects after this.

Ex:

loctry unpublish <package-name>

Install

Install your local package in the current project

Ex:

loctry install <package-name>

List

List available packages in the local registry

Info

Show info stored about the given package

Ex:

loctry info <package-name>

LICENSE

This project is under MIT licence. See the archive LICENSE to more details.