Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/herrjulz/resc
ReSc runs remote bash scripts located on Github on your local machine
https://github.com/herrjulz/resc
executor github go golang remote resc runner script
Last synced: 3 days ago
JSON representation
ReSc runs remote bash scripts located on Github on your local machine
- Host: GitHub
- URL: https://github.com/herrjulz/resc
- Owner: herrjulz
- License: mit
- Created: 2018-06-29T07:58:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-20T09:30:40.000Z (over 6 years ago)
- Last Synced: 2024-12-15T19:47:41.254Z (about 2 months ago)
- Topics: executor, github, go, golang, remote, resc, runner, script
- Language: Go
- Homepage:
- Size: 20.5 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ReSc (Remote Script)
`resc` is a CLI tool that executes remote _bash_ scripts located on Github on your local machine. This allows you to:
- **Share your scripts easily**
- **Run your scripts everywhere** (as long as it is a mac or linux machine 😉)
## Install
### OS X
```
$ wget -O /usr/local/bin/resc https://github.com/JulzDiverse/resc/releases/download/v0.4.0/resc-darwin-amd64 && chmod +x /usr/local/bin/resc
```
OR
**Homebrew**
```
$ brew tap julzdiverse/tools
$ brew install resc
```
### Linux
```
$ wget -O /usr/bin/resc https://github.com/JulzDiverse/resc/releases/download/v0.4.0/resc-linux-amd64 && chmod +x /usr/bin/resc
```
## Hello, World!
You can use `resc` to run `resc` scripts located in any Github repository. For example, let's run a `Hello, World!` script:
```bash
$ resc run hello-world --repo JulzDiverse/remote-scripts
```
This runs the `hello-world` script located in the `JulzDiverse/remote-scripts` repository.
## `resc` scripts
`resc` scripts require one or more top level directories inside a GitHub repository that contain a `run.sh` script, a `.resc`, and a `README.md` file. In case of the `hello-world` script the directory looks like this:
```
.remote-scripts
└── hello-world
├── .resc
├── run.sh
└── README.md
```
- The `directory name` (here `hello-world`) indicates the script name
- The `.resc` is an empty file that indicates that the directoy is a `resc` script directory
- The `run.sh` is the bash script that is run by `resc`
- The `README.md` is a Markdown file that provides information for a script (eg description, usage). The `README.md` is processed by the `resc` CLI and should only contain the following markdown syntax:
- H1 (#)
- H2 (##)
- Bold (\*\*text\*\*)
- Italic (\_text\_)
## Usage
### 🏃 Run `resc` scripts (`run`)
Running a `resc` script is nothing more than:
```
$ resc run --repo /
```
or if you have set a default repository, it's even simpler:
```
$ resc run
```
You can provide parameters to a script using `--args|-a` option. Try it:
```
$ resc run hello-world -r JulzDiverse/remote-scripts -a your-name
```
You can also run a specific script located anywhere in a repository by providing the path to the script:
```bash
$ resc run -s -r JulzDiverse/remote-scripts
```
### 🧐 Set default `resc` script repository (`set`)
You can set a default `resc` script repository, s.t you are not required to specify the repository of a script everytime you execute the `resc run`.
```
$ resc set /
```
### ✅ List all available scripts in a resc repository (`list`)
If you want to know which `resc` scripts a repository provides, you can list all of them using `list`.
If you have set a default repository you can run just:
```bash
$ resc list
```
If you want to list scripts of a specific repository, run:
```bash
$ resc list /
```
### 📖 Get some script info (`man`)
If you want to know what a script does before you run it, you can check the provided README by calling `man`:
```bash
$ resc man
```
### 🖨 Print a script (`print`)
If you want to see what a script exactly does or you want to save it to your local machine, you can use the `print` command:
```bash
$ resc print
```
to save a script, pipe it to a file:
```bash
$ resc print > script.sh
```
### 🌿 Specifing a Branch
Each `resc` command has the `--branch|-b` option, where you can specify a specific branch of a repository you want to use to execute a script. For example:
```
$ resc run hello-world -r JulzDiverse/remote-scripts -b develop
```
The default branch used is always `master`. You can, however, set a default branch if required:
```bash
# if you have set your defaults already:
$ resc set -b develop
# if you haven't set your defaults:
$ resc set / -b develop
```
## 💻 Development
```
$ go get github.com/JulzDiverse/resc (or git clone repository)
$ dep ensure
```