shell

README

Go Shell

Overview

A simple wrapper around exec package to easily run shell commands in Go. It provides lots of defaults and also handles some common usage patterns like handing input and getting output from the command.

Environment Details

GoLang 1.21.5

Usage

Check the example folder for some basic usage guide of this package. To enable debugging while working with this package set DEBUG environment variable to true (Execute export DEBUG=true). Run the example: go run example/main.go.

Contributing

Feel free to contribute to this repository by opening issues, providing feedback, or submitting pull requests. Your contributions are highly appreciated!

License

This Repository is licensed under the MIT License. Feel free to use, modify, and distribute the code as per the terms of the license.

Documentation

Index

• Constants
• func Sh(command string, params ...shellParams) (string, error)
• func ShA(command string, params ...shellParams) (string, int, error)
• func ShI(command string, input string, params ...shellParams) (string, error)

Constants

const (
	NoPanic      shellParams = "noPanic"
	WithoutShell shellParams = "WithoutShell"
	UseStdin     shellParams = "UseStdin"
	UseStdOut    shellParams = "UseStdOut"
)

Functions

func Sh

func Sh(command string, params ...shellParams) (string, error)

func ShA

func ShA(command string, params ...shellParams) (string, int, error)

func ShI

func ShI(command string, input string, params ...shellParams) (string, error)