Biryani CLI

A tool to manage all your dependencies.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Biryani is a tool created to manage dependecies of your github repositories without locally installing any of them . Given the current version of a dependency with a csv of repositories, biryani can tell if the version is greater than or equal to the version specified or not and update it and create a pull request.

Built With

• arg
• octokit
• chalk
• cli-table
• configstore
• configstore
• esm
• inquirer

(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

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

• Github private access token Create a personal access token from : https://github.com/settings/tokens/new?scopes=repo,user (will be only asked )

Installation

1. Install NPM packages

npm install -g @devashar13/biryani

And biryani will be installed globally to your system path.

Usage

To check if installation was successful, use the command:

biryani

After installation, run the command below in your terminal:

biryani --help 

Create a .csv file with the format

name,repo
reponame,https://github.com/username/reponame

Check Sample CSV

The help menu with all the options will be listed.

biryani -i <path-to-csv> <library@version>

Use the above command to get current version of the library being used in the repositories and check if the version is satisfied with the given version

Sample Output:

biryani -u -i <path-to-csv> <library@version>

Use the above command to get current version of the library being used in the repositories and check if the version is satisfied with the given version and update the version and create a pull request

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(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

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

(back to top)

Acknowledgments

(back to top)