commandrun

package

v0.1.0 Latest Latest Go to latest Published: Jul 14, 2026 License: MIT Imports: 8 Imported by: 0

Details

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

Repository

github.com/Rememorio/codog

Links

Open Source Insights

Documentation ¶

Overview ¶

Package commandrun executes workspace commands and renders their results.

Index ¶

func RenderText(out io.Writer, result Result)
type Options
type Result
- func Run(ctx context.Context, opts Options) (Result, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func RenderText ¶

func RenderText(out io.Writer, result Result)

RenderText writes a human-readable command result.

Types ¶

type Options ¶

type Options struct {
	Workspace string
	Command   []string
	Timeout   time.Duration
	Kind      string
}

Options configures a workspace command run.

type Result ¶

type Result struct {
	Kind           string   `json:"kind"`
	Workspace      string   `json:"workspace"`
	Command        []string `json:"command"`
	ExitCode       int      `json:"exit_code"`
	Stdout         string   `json:"stdout,omitempty"`
	Stderr         string   `json:"stderr,omitempty"`
	TimedOut       bool     `json:"timed_out,omitempty"`
	DurationMillis int64    `json:"duration_millis"`
}

Result captures the outcome of a workspace command run.

func Run ¶

func Run(ctx context.Context, opts Options) (Result, error)

Run executes opts.Command in opts.Workspace and captures stdout, stderr, and exit status.

Source Files ¶

View all Source files

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