README
¶
Quick Script Runner
Made with :heart: by @GreatGodApollo
Quick Script Runner (qsr) is a command line utility program that allows users to run code from github gists quickly with just a single command
Installing
Standard Download
Just head on over to the releases page and download the latest release
for your platform. Extract it using something like 7-Zip for Windows or tar on other
platforms (tar -zxvf qsr*.tar.gz).
That's it! Although you'll probably want to also add the binary to your path for ease of use.
Scoop
Do you happen to have scoop installed? Well lucky for you, I happen to have a scoop bucket. Said bucket's name is Trough.
$ scoop bucket add trough https://github.com/GreatGodApollo/trough.git
$ scoop install qsr
Go Get
Do you have go installed? You can run just one simple command to install QSR!
$ go get -u github.com/GreatGodApollo/qsr
Usage
$ qsr --help
Quick Script Runner is a command line utility that allows you to run gists
with a single command.
Usage:
qsr [command]
Available Commands:
docs Documentation Generator
help Help about any command
link Link a gist or file alias
run Run a remote gist
source Get a link to the source code
unlink Remove a gist or file alias
Flags:
--config string config file (default is $HOME/.qsr.json)
-h, --help help for qsr
--version version for qsr
Use "qsr [command] --help" for more information about a command.
Configuration
These values can be set in ~/.qsr.json. The options listed are unable to be used as alias names.
Configuration options available:
token - Personal OAuth token for Github
A personal OAuth token can be generated on your tokens page. This allows for the 60 requests per hour limit to be surpassed.
This token does not need any special scopes.
Included Gists
To prevent overcrowding this README, the included gist aliases are located in gists.md
Supported Languages
- Batch (Windows Only)
- Golang
- JavaScript
- Python 2 & 3 (Set with shebang ie.
#!/usr/bin/python3) - Ruby
- Shell
This list can be expanded on, either create an issue, or a PR to request a new language!
Built With
Compiling
To compile the executable from the source, it's extremely easy, and can be done in as little as 3 commands.
You can follow these instructions to build:
# This assumes you already have git and golang installed.
$ git clone https://github.com/GreatGodApollo/qsr.git
$ cd qsr
$ go build
Licensing
This project is licensed under the GNU Affero General Public License v3.0
Authors
Documentation
¶
Overview ¶
* Quick Script Runner: A quick and easy way to run gists * Copyright © 2020 Brett Bender * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by * the Free Software Foundation, either version 3 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 Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
* Quick Script Runner: A quick and easy way to run gists * Copyright © 2020 Brett Bender * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version.
|
* Quick Script Runner: A quick and easy way to run gists * Copyright © 2020 Brett Bender * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. |