README.md

Helping Hand

A simple CLI tool that streamlines our company's workflow.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation

About The Project

Just exhausted of repeatedly doing certain day to day actions. This cli tool provides improved quality of life (personally) at work.

Built With

• Node.js
• Typescript

Getting Started

To run the tool on your machine, follow these simple steps.

Prerequisites

Make sure you have node installed on your machine.

Installation

1. Clone the repo

   git clone https://github.com/johnkenneth99/helping-hand.git

2. Install NPM packages

   npm install

3. Compile

   npm run tsc

4. Install the tool globally on your machine

   npm install -g

5. Initialize default config

   hand init

(back to top)