Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/99x/runn
Make your own terminal aliases easily!
https://github.com/99x/runn
aliases hacktoberfest node terminal-tool
Last synced: 3 months ago
JSON representation
Make your own terminal aliases easily!
- Host: GitHub
- URL: https://github.com/99x/runn
- Owner: 99x
- License: mit
- Created: 2019-02-13T07:17:53.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-30T10:52:21.000Z (over 1 year ago)
- Last Synced: 2024-05-22T23:35:59.807Z (6 months ago)
- Topics: aliases, hacktoberfest, node, terminal-tool
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/runnit
- Size: 33.2 KB
- Stars: 21
- Watchers: 2
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
_ __ _ _ _ __ _ __
| '__| | | | '_ \| '_ \
| | | |_| | | | | | | |
|_| \__,_|_| |_|_| |_|
Make your own terminal aliases easily!
## Table of Contents
* [About the Project](#about-the-project)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Example](#example)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
## 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
```sh
$ npm install npm@latest -g
```
### Installation
1. Install the NPM packages
```sh
$ npm i -g runnit
```
2. Save it
```sh
$ runn cu "curl https://raw.githubusercontent.com/shalithasuranga/runn/master/bin/runn.js"
```
## Usage
### runn it!
```sh
$ 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"
```sh
$ runn gaa "git add ."
```
b) Now lets add our second alias for "git push origin master" as "gpom"
```sh
$ runn gpom "git push origin master"
```
3) Now your new aliases are added. To use this you need to change your directory to a Github project directory.
a) Using gaa alias
```sh
$ runn gaa
```
*You can see that your files are staged.
b) Using gpom alias
```sh
$ runn gpom
```
*Your commits will push to origin master
## Roadmap
See the [open issues](https://github.com/99xt/runn/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](https://github.com/99xt/runn/blob/master/LICENSE).
### Contributors
Made with [contributors-img](https://contributors-img.firebaseapp.com).