THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Brett Bender a075f8bba2
Merge branch 'master' of github.com:GreatGodApollo/qsr
1 month ago
.chglog docs: Update changelog template 1 month ago
.github Update issue templates 1 month ago
assets/img Added banner image 2 months ago
cmd feat: API authentication 1 month ago
.gitignore Update documentation generator 2 months ago
CHANGELOG.md feat: API authentication 1 month ago
CODE_OF_CONDUCT.md docs: Create code of conduct 1 month ago
LICENSE Initial Commit 2 months ago
README.md feat: API authentication 1 month ago
gists.md Tell users they can get on gists.md 2 months ago
go.mod feat: API authentication 1 month ago
go.sum feat: API authentication 1 month ago
main.go Finally fix that stupid main.go 2 months ago

README.md

Banner

Quick Script Runner

Made with ❤️ 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