Categorygithub.com/go-corelibs/run
modulepackage
1.0.1
Repository: https://github.com/go-corelibs/run.git
Documentation: pkg.go.dev

# README

godoc codecov Go Report Card

run - Go-Curses safe exec.Command wrappers

run is a package for running commands and updating Go-Curses based user interfaces with the STDOUT and STDERR of the running process.

Installation

> go get github.com/go-corelibs/run@latest

Examples

Callback

func main() {
    pid, done, err := run.Callback(Options{
    }, func(line string) {
        // update user interface with normal output
    }, func(line string) {
        // update user interface with error output
    })
    if err != nil {
        panic(err)
    }
    // pid != 0
    <-done // if waiting for command to finish is necessary
}

Go-CoreLibs

Go-CoreLibs is a repository of shared code between the Go-Curses and Go-Enjin projects.

License

Copyright 2023 The Go-CoreLibs Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use file except in compliance with the License.
You may obtain a copy of the license at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

# Functions

Callback runs the command defined by the Options and pipes the standard and error output streams, line by line, to their respective stdout and stderr functions.
Run is a wrapper around With configured with the given Options and the default os.Environ.
With is a blocking function which runs a command with the Options given and if there is an error, looks for the last non-empty line of output to STDERR (and if that's empty, checks STDOUT) and returns that as the function `err` return value.

# Structs

Options defines the command to be run.