Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 2.06 KB

README.md

File metadata and controls

76 lines (47 loc) · 2.06 KB
Raw

📦 try

Quickly try out npm packages inside a container.

NPM Package Dependencies Build Status

Demo animation

Purpose

As a developer working with NodeJS you often stumble upon packages you quickly want to try out. Installing these packages on your host system gets it polluted real quick.

try tries to keep your host system clean while testing out npm packages. This CLI tool quickly starts up a Docker container and installs your specified packages, so you can try them out!

Usage

You can print the usage by executing try --help.

Usage: try [options]

Quickly try out npm packages inside a container

Options:
  -V, --version              output the version number
  -v, --verbose              Verbosity value
  -i, --image [image]        The docker image which it should pull from (default: "node")
  --image-version [version]  Specify the node image version (default: "latest")
  --no-cleanup               If set to true, the created container will not get cleaned up
  --silent                   If the program should not print any log statements
  --ts                       If it the program should use TypeScript
  -h, --help                 output usage information

Installation

Prerequisites

npm package

To install try using npm run:

npm install -g try-pkg

From source

To install it from source you need to clone this repository, install the dependencies using npm and execute the program.

git clone https://github.com/BrunnerLivio/try.git
cd try
npm install
npm start

Other

Inspired by timofurrer/try - Thanks buddy :)