Skip to content

Latest commit

 

History

History
142 lines (90 loc) · 4.53 KB

README.md

File metadata and controls

142 lines (90 loc) · 4.53 KB
Raw

Open in Visual Studio Code


Logo

Github cli-tool

A CLI tool for keeping packages in a repositories up-to-date.
· Report Bug · Request Feature

About The Project

A CLI tool to help in managing package versions on Github repositories.

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

  1. Install npm
  • npm 
    npm install npm@latest -g
  1. Download git from - https://git-scm.com/downloads

Installation

  1. Clone the repo 
    git clone https://github.com/dyte-submissions/dyte-vit-2022-singhalyash8080
  2. Install the package globally on your machine 
    npm i -g

(back to top)

Usage

Store your csv file in the csv_files folder in the root directory.

then 2 options are available

  1. cli-tool -i <csv_file_name> <package_name_with_version> (for 1st feature)

eg. - cli-tool -i input1.csv axios@0.23.1 image

  1. cli-tool -u <csv_file_name> <package_name_with_version> (for 2nd feature - incomplete)

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - singhal.yash8080@gmail.com

Project Link: https://github.com/dyte-submissions/dyte-vit-2022-singhalyash8080

(back to top)