Skip to content

kd-singh-dev/Git-CLI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The Documentation Compendium

Welcome to Git-Cli

Table of Contents

About

git-Cli is a CLI tool automation tool developed to maintain the packages of multiple projects of an organization up to date. It provides a simple and hassle-free process of updating outdated dependencies of a repository, to do so CLIis fed with the repo name and linked to it, this can be easily done for multiple repositories at once using the .csv file. Once data is fed into the CLI, it makes GitHub API calls to fetch package versions if found that a package is outdated we also have an option to --update the package and simultaneously create a pull request to update the package.

Getting Started

Follow the process below to start working with git-Cli.

Prerequisites

make sure u have a stable version of npm and node.js installed locally on your pc.

  • npm
    npm install npm@latest -g

Downloading and installing Node.js and npm

Installation

  1. Clone the repo

    git clone https://github.com/your_username_/Project-Name.git
  2. Install NPM packages

    npm install
  3. Link NPM

    npm link
  4. Get a free access token Key from github follow the link for the same. Creating a personal access token

  5. Enter your Token in .env file

     Token = [ENTER YOUR Token];

(back to top)

Usage

Adding .CSV file to ./Data

Help cmd

_used to view cmd's and documentations_
  • cmd
git-cli -h
  • expected output image

show cmd

Is used to view input.csv file

  • cmd
git-cli show
  • expected output image

Input cmd

Is used to fed in data to the CLI

  • cmd
git-cli input input.csv <package>@<version>
  • expected output image

Update cmd

used to generate pull request for outdated packages

  • cmd
git-cli input input.csv <package>@<version> update
  • expected output image

    Pull req musht be created image

    Pull Req image

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published