Skip to content

Latest commit

 

History

History
135 lines (100 loc) · 3.78 KB

README.md

File metadata and controls

135 lines (100 loc) · 3.78 KB
                         
  _ __ _   _ _ __  _ __  
 | '__| | | | '_ \| '_ \ 
 | |  | |_| | | | | | | |
 |_|   \__,_|_| |_|_| |_|
                         
                          

Make your own terminal aliases easily!

Table of Contents

About the Project

Runn is a command line tool which help you to make your own terminal aliases easily.

Getting Started

Prerequisites

You need to install node package manager to runn this!

  • npm
$ npm install npm@latest -g

Installation

  1. Install the NPM packages
$ npm i -g runnit
  1. Save it
$ runn cu "curl https://raw.githubusercontent.com/shalithasuranga/runn/master/bin/runn.js"

Usage

runn it!

$ runn cu

Example(Adding and using some Git commands)

  1. After setting up, You may follow these steps. (*You can add your alias from anywhere in the directory)
  2. I am adding two git commands to aliases.

a) First lets add "git add ." to an alias called "gaa"

$ runn gaa "git add ."

b) Now lets add our second alias for "git push origin master" as "gpom"

$ runn gpom "git push origin master"
  1. Now your new aliases are added. To use this you need to change your directory to a Github project directory.

a) Using gaa alias

$ runn gaa 

*You can see that your files are staged.

b) Using gpom alias

$ runn gpom 

*Your commits will push to origin master

Roadmap

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

Contributing

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

  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

License

Distributed under the MIT License.

Contributors

Made with contributors-img.