Skip to content

a simple CLI tool to run long terminal commands by aliases

Notifications You must be signed in to change notification settings

mohamedeliwa/rupit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rupit

A simple CLI tool to run long, complex, and multistep terminal commands by aliases.

using a configuration file rupit.json, that contains the list of aliases for rupit to use.

How to use

For Linux users you can use the pre-built binary from the releases page , it's built and tested on Ubuntu 22.04.4 LTS,

or you can build from source for linux, windows, and macOS systems using the following steps:

  1. Pull the repo:
git pull [email protected]:mohamedeliwa/rupit.git
  1. Build the project with:
cargo build --release
  1. Put the release binary in a suitable execution path
  2. Create rupit.json file, with a structure similar to the following:
{
  "aliases": {
    "greetings": "echo \"Hello World\"",
    "multistep": "cd ~; touch test.txt"
  }
}

Note: depending on your OS the path at which to put the file will be

Linux: /home/<user>/.config/rupit/rupit.json

Windows: C:\Users\<user>\AppData\Roaming\Foo Corp\Bar App\rupit.json

macOS: /Users/<user>/Library/Application Support/com.Foo-Corp.Bar-App/rupit.json

  1. Run the command with an alias name rupit <ALIAS>
rupit greetings

this will execute the following:

echo "Hello World"

Hello World

Available Commands

  • rupit run <alias> -> to run specific alias command from the config file.
  • rupit show -c -> to show the expected path of the config file.
  • rupit show -a <alias> -> to print the alias corresponding command without executing it.
  • rupit help -> to print the help message

About

a simple CLI tool to run long terminal commands by aliases

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages