shell

package

v0.2.0 Latest Latest Go to latest Published: Jan 14, 2021 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/spy16/pkg

Links

Open Source Insights

Documentation ¶

Overview ¶

Package shell provides helpers for executing shell commands and wrappers for popular commands (e.g., git).

Index ¶

func Clone(targetDir, repoURL string) error
func Commit(targetDir, message string) ([]byte, error)
func Exec(workingDir, name string, args ...string) ([]byte, error)
func Init(targetDir string, name string) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Clone ¶

func Clone(targetDir, repoURL string) error

Clone runs 'git clone' with the repoURL and clones the repo contents into targetDir. targetDir must be an empty directory.

func Commit ¶

func Commit(targetDir, message string) ([]byte, error)

Commit runs `git commit -m message` and returns the output.

func Exec ¶

func Exec(workingDir, name string, args ...string) ([]byte, error)

Exec executes the given command within workingDir and returns the stdout. If there is an error in starting the command or the command exits with non zero code, returns the stderr wrapped in Go error.

func Init ¶

func Init(targetDir string, name string) error

Init initializes a git repo in the given directory.

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL