gosh

README

gosh

A golang library for executing bash & powershell commands easly.

Install

go get -v github.com/abdfnx/gosh

Examples

Run one command on both shell and powershell

package main

import (
  "fmt"
  "log"

  "github.com/abdfnx/gosh"
)

// run a command
gosh.Run("git status")

// run a command with output
err, out, errout := gosh.RunOutput("echo 𝜋")

if err != nil {
  log.Printf("error: %v\n", err)
  fmt.Print(errout)
}

fmt.Print(out)

How gosh.Run("COMMAND") works ?

// `Run` executes the same command for shell and powershell
func Run(cmd string) {
	err, out, errout := ShellOutput("")

	if runtime.GOOS == "windows" {
		err, out, errout = PowershellOutput(cmd)
	} else {
		err, out, errout = ShellOutput(cmd)
	}

	if err != nil {
		log.Printf("error: %v\n", err)
		fmt.Print(errout)
	}

	fmt.Print(out)
}

Run Powershell Command(s)

package main

import (
  "fmt"
  "log"

  "github.com/abdfnx/gosh"
)

// run a command
gosh.PowershellCommand(`Write-Host "hello from powershell"`)

// run a script
gosh.PowershellCommand(`
  $git_username = git config user.name

  Write-Host $git_username
`)

// run a command with output
err, out, errout := gosh.PowerShellOutput(`[System.Environment]::SetEnvironmentVariable("Path", $Env:Path + ";$APP_PATH\bin", [System.EnvironmentVariableTarget]::User)`)

if err != nil {
  log.Printf("error: %v\n", err)
  fmt.Print(errout)
}

fmt.Print(out)

Run Bash/Shell Command(s)

package main

import (
  "fmt"
  "log"

  "github.com/abdfnx/gosh"
)

// run a command
gosh.ShellCommand(`echo "shell or bash?"`)

// run a script
gosh.ShellCommand(`
  mood="👨‍💻"

  if [ $mood != "😪" ]; then
    echo "still coding"
  fi
`)

// run a command with output
err, out, errout := gosh.ShellOutput(`curl --silent "https://get-latest.onrender.com/docker/compose"`)

if err != nil {
  log.Printf("error: %v\n", err)
  fmt.Print(errout)
}

fmt.Print(out)

Documentation

Index

• func Exec(shell, command string) (error, string, string)
• func PowershellCommand(command string)
• func PowershellOutput(command string) (error, string, string)
• func PowershellOutputWithDir(command, dir string) (error, string, string)
• func Run(cmd string)
• func RunMulti(unixCmd string, winCmd string)
• func RunMultiOutput(unixCmd string, winCmd string) (error, string, string)
• func RunOutput(command string) (error, string, string)
• func ShellCommand(command string)
• func ShellOutput(command string) (error, string, string)
• func ShellOutputWithDir(command, dir string) (error, string, string)

Functions

func Exec

func Exec(shell, command string) (error, string, string)

`Exec` just exectes the command

func PowershellCommand

func PowershellCommand(command string)

`PowershellCommand` executes the powershell command.

func PowershellOutput

func PowershellOutput(command string) (error, string, string)

`PowershellOutput` returns the output of powershell command, and any errors.

func PowershellOutputWithDir

func PowershellOutputWithDir(command, dir string) (error, string, string)

func Run

func Run(cmd string)

`Run` executes the same command for shell and powershell

func RunMulti

func RunMulti(unixCmd string, winCmd string)

`RunMulti` executes a command for shell and a command for powershell

func RunMultiOutput

func RunMultiOutput(unixCmd string, winCmd string) (error, string, string)

`RunMultiOutput` returns the output of the shell command and the powershell command

func RunOutput

func RunOutput(command string) (error, string, string)

`RunOutput` returns the output of the shared command for shell and powershell

func ShellCommand

func ShellCommand(command string)

`ShellCommand` executes the shell command.

func ShellOutput

func ShellOutput(command string) (error, string, string)

`ShellOutput` returns the output of shell command, and any errors.

func ShellOutputWithDir

func ShellOutputWithDir(command, dir string) (error, string, string)