binary

package

v1.0.40357-pre Latest Latest Go to latest Published: Jun 16, 2026 License: MIT Imports: 17 Imported by: 0

Details

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

Repository

github.com/CircleCI-Public/circleci-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package binary builds the circleci CLI binary once per test run and provides helpers for running it in tests.

Index ¶

func Build(binaryName, relativeDir, source string) (string, func(), error)
func RunCLIInteractive(t testing.TB, opts RunOpts) *expect.Console
type CLIResult
- func RunCLI(t *testing.T, opts RunOpts) CLIResult
type RunOpts

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Build ¶

func Build(binaryName, relativeDir, source string) (string, func(), error)

func RunCLIInteractive ¶

func RunCLIInteractive(t testing.TB, opts RunOpts) *expect.Console

RunCLIInteractive executes the circleci binary attached to a PTY and returns both the running command and the console so callers can drive interactive input with Expect/Send. Call cmd.Wait() after interaction is complete.

Types ¶

type CLIResult ¶

type CLIResult struct {
	Stdout   string
	Stderr   string
	ExitCode int
}

CLIResult holds the output of a CLI invocation.

func RunCLI ¶

func RunCLI(t *testing.T, opts RunOpts) CLIResult

RunCLI executes the circleci binary with the given args, env, and working directory.

type RunOpts ¶

type RunOpts struct {
	Binary  string
	Args    []string
	Env     []string
	WorkDir string
	TTY     bool
	// Stdin, if non-nil, is connected to the CLI's stdin (non-TTY mode only).
	// TTY mode always uses the expect pty.
	Stdin io.Reader
}

Source Files ¶

View all Source files

binary.go

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