RMS (Run My Script) CLI Tool

RMS is a command-line interface tool designed to manage and run your local scripts efficiently. It allows you to create aliases for your scripts, making them easy to access and execute from anywhere in your system.

Installation
Usage
Commands
- link
- list
- run
- search
- unlink
- version
Configuration
Contributing
License

Installation

Linux/macOS

To install RMS on Linux or macOS, you can use the following curl command:

curl -s https://github.com/shashankx86/att/raw/main/install.sh | bash

This command downloads and runs the installation script, which will set up RMS on your system.

Windows

<wip>

Manual Installation

If you prefer to install RMS manually or if you're using a different operating system, follow these steps:

Ensure you have Go installed on your system. If not, download and install it from golang.org.

Clone the repository:

git clone https://github.com/yourusername/rms.git

Navigate to the project directory:
```
cd rms
```
Build the project:
```
go build
```
(Optional) Move the built binary to a directory in your PATH for easy access:
```
sudo mv rms /usr/local/bin/
```

Usage

After installation, you can use RMS with the following syntax:

rms [command] [arguments]

If you run rms without any arguments, it will display a list of all your linked scripts and binaries.

Commands

link

Add a new script or binary to RMS.

rms link [path]

You'll be prompted to enter details such as alias, arguments, execution command, and description. If a link with the same alias already exists, you'll be asked if you want to overwrite it.

list

Display all linked scripts and binaries.

rms list

run

Execute a linked script or binary using its alias or path.

rms run [alias|path]

search

Search for links using a regex pattern.

rms search [pattern]

The search will look for matches in the alias, path, and description fields.

unlink

Remove a link from RMS.

rms unlink [alias|filename]

version

Display the version of RMS.

rms version

Configuration

RMS stores its configuration and link data in a JSON file. The location of this file may vary depending on your system, but it's typically in your home directory or a dedicated config directory.

Contributing

Contributions to RMS are welcome! Please feel free to submit a Pull Request.

Gallery

License

RMS is licensed under the GNU General Public License v2.0 (GPL-2.0).
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

shashankx86/rms