initial commit

Author: herrjulz

.gitignore

@@ -0,0 +1 @@
+vendor/

Gopkg.lock

@@ -0,0 +1,58 @@
+# Gopkg.toml example
+#
+# Refer to https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md
+# for detailed Gopkg.toml documentation.
+#
+# required = ["github.com/user/thing/cmd/thing"]
+# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
+#
+# [[constraint]]
+#   name = "github.com/user/project"
+#   version = "1.0.0"
+#
+# [[constraint]]
+#   name = "github.com/user/project2"
+#   branch = "dev"
+#   source = "github.com/myfork/project2"
+#
+# [[override]]
+#   name = "github.com/x/y"
+#   version = "2.4.0"
+#
+# [prune]
+#   non-go = false
+#   go-tests = true
+#   unused-packages = true
+
+
+[[constraint]]
+  name = "github.com/fatih/color"
+  version = "1.7.0"
+
+[[constraint]]
+  name = "github.com/ghodss/yaml"
+  version = "1.0.0"
+
+[[constraint]]
+  name = "github.com/onsi/ginkgo"
+  version = "1.5.0"
+
+[[constraint]]
+  name = "github.com/onsi/gomega"
+  version = "1.4.0"
+
+[[constraint]]
+  name = "github.com/pkg/errors"
+  version = "0.8.0"
+
+[[constraint]]
+  name = "github.com/spf13/cobra"
+  version = "0.0.3"
+
+[[constraint]]
+  name = "gopkg.in/yaml.v2"
+  version = "2.2.1"
+
+[prune]
+  go-tests = true
+  unused-packages = true

Gopkg.toml

@@ -0,0 +1,114 @@
+# ReSc (Remote Script) - The easy way to share scripts
+
+`resc` is a CLI tool that executes remote bash scripts located on Github.
+
+## Install
+
+### OS X
+
+```
+$ wget -O /usr/local/bin/resc https://github.com/JulzDiverse/resc/releases/download/v0.1.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.1.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 requires one or more top level directories inside a GitHub repository that contain a `run.sh` script and a `README.md` file. In case of the `hello-world` script the directory looks like this:
+
+```
+.remote-scripts
+└── hello-world 
+   ├── run.sh
+   └── README.md
+``` 
+
+- The `directory name` (here `hello-world`) indicates the script
+- 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 <script-name> --repo <github-user|github-org>/<github-repo>
+```
+
+or if you have set a repository, it's even simpler:
+
+```
+$ resc run <script-name>
+```
+
+You can also provide parameters to a script using `--args|-a` option. Try it:
+
+```
+$ resc run hello-world -r JulzDiverse/remote-scripts -a your-name
+```
+
+### Set base `resc` script repository (`set`)
+
+You can set a base `resc` script repository, s.t you are not required to specify the repository of a script everytime you execute the `resc run`.
+
+```
+$ resc set <github-user|github-org>/<github-repo>
+```
+
+### 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`:
+
+```
+$ resc man <script-name> 
+```
+
+### Print a script (`man`)
+
+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:
+
+```
+$ resc print <script-name>
+```
+
+to save a script, pipe it to a file:
+
+```
+$ resc print <script-name> > script.sh
+```
+
+## Development
+
+```
+$ go get github.com/JulzDiverse/resc (or git clone repository)
+$ dep ensure
+```

README.md

@@ -0,0 +1,51 @@
+package cmd
+
+import (
+	"bufio"
+	"fmt"
+	"strings"
+
+	"github.com/JulzDiverse/resc/processor"
+	"github.com/JulzDiverse/resc/scriptmanager"
+	"github.com/spf13/cobra"
+)
+
+var manCmd = &cobra.Command{
+	Use:   "man",
+	Short: "prints the description of the script",
+	Run:   man,
+}
+
+func man(cmd *cobra.Command, args []string) {
+	userRepo, err := cmd.Flags().GetString("repo")
+	exitWithError(err)
+
+	var user, repo string
+	if userRepo == "" {
+		user, repo = configFromFile()
+	} else {
+		sl := strings.Split(userRepo, "/")
+		user = sl[0]
+		repo = sl[1]
+	}
+
+	scriptManager := scriptmanager.New(
+		"https://raw.githubusercontent.com",
+		user,
+		repo,
+	)
+
+	readme, err := scriptManager.GetReadmeForScript(args[0])
+	exitWithError(err)
+
+	scanner := bufio.NewScanner(strings.NewReader(string(readme)))
+	processor := processor.New()
+	for scanner.Scan() {
+		line := processor.Process(scanner.Text())
+		fmt.Println(line)
+	}
+}
+
+func initMan() {
+	manCmd.Flags().StringP("repo", "r", "", "name of the repository containing the script. Pattern: <user|org>/<repo>")
+}