gh

Documentation

Overview

Directly taken from: https://github.com/cli/go-gh LICENSE: MIT License

Copyright (c) 2021 GitHub Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• func CreateCommand(ctx context.Context, ghExe string, env []string, stdin io.Reader, ...) *exec.Cmd
• func Exec(args ...string) (stdout, stderr bytes.Buffer, err error)
• func ExecContext(ctx context.Context, args ...string) (stdout, stderr bytes.Buffer, err error)
• func ExecIn(workingDirectory string, args ...string) (stdout, stderr bytes.Buffer, err error)
• func ExecInteractive(ctx context.Context, args ...string) error
• func Path() (string, error)

Functions

func CreateCommand

func CreateCommand(ctx context.Context, ghExe string, env []string, stdin io.Reader, stdout, stderr io.Writer, args []string) *exec.Cmd

func Exec

func Exec(args ...string) (stdout, stderr bytes.Buffer, err error)

Exec invokes a gh command in a subprocess and captures the output and error streams.

func ExecContext

func ExecContext(ctx context.Context, args ...string) (stdout, stderr bytes.Buffer, err error)

ExecContext invokes a gh command in a subprocess and captures the output and error streams.

func ExecIn

func ExecIn(workingDirectory string, args ...string) (stdout, stderr bytes.Buffer, err error)

func ExecInteractive

func ExecInteractive(ctx context.Context, args ...string) error

Exec invokes a gh command in a subprocess with its stdin, stdout, and stderr streams connected to those of the parent process. This is suitable for running gh commands with interactive prompts.

func Path

func Path() (string, error)

Path searches for an executable named "gh" in the directories named by the PATH environment variable. If the executable is found the result is an absolute path.