/quickinstall

A CLI for quickly installing packages, provides support for NPM, Yarn and PNPM

Primary LanguageJavaScriptMIT LicenseMIT

quickinstall

A CLI for quickly installing packages, provides support for NPM, Yarn and PNPM!

Demo GIF Demo 2 GIF


Installation

You can install quickinstall to your system by running this command:

npm i -g @yoshiboi18303/quickinstall

After that just run:

quickinstall

And follow the prompts, it's that easy!


Debug Mode

This CLI provides a debug mode, if you want to get more information.

There are two ways to activate debug mode...

Way 1, config file

This method requires a configuration file, here's how you would go about this:

Step one: Create a quickinstall.json file in the current working directory (AKA, where your terminal/project is).

Step two: Replace the contents of the configuration file with this:

{
  "debug": true
}

This will enable debug mode, if you ever want it off, either set debug to false or remove the configuration file.

Way 2, debug option

This CLI also provides a --debug option, here's how to use this with the CLI:

quickinstall --debug

OR

quickinstall -d

This will add debug messages to the console.


Use this source code

Here's how you can use this CLI's source code.

Prerequisites

You will need: Node.js, npm (bundled with Node.js) and Python (optional, to run the provided scripts)

Bolded prerequisites are required.


Here's what you need to do after installing the required prerequisites:

1. Clone the repository

2. THIS IS A ONE-TIME ONLY STEP

Run this in the project directory:

npm link

3. Make whatever changes you want to the TypeScript files.

4. Once you're ready to test, run:

If you have Python installed:

npm run build

Otherwise, run:

npx tsc --outDir bin

Made with ❤️ (and TypeScript) by Yoshiboi18303