Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

command

package

Go to main page

Versions in this module

v0

v0.4.0

Aug 19, 2026

Changes in this version

+ var ErrArgumentNotAllowed = errors.New("argument not allowed")

v0.3.0

Aug 17, 2026

v0.2.0

Aug 13, 2026

v0.1.4

Aug 12, 2026

v0.1.3

Aug 12, 2026

v0.1.2

Aug 12, 2026

v0.1.1

Aug 12, 2026

v0.1.0

Aug 12, 2026

Changes in this version

+ var ErrCommandNotAllowed = errors.New("command not allowed")

+ var ErrConnectionClosed = errors.New("connection closed")

+ var ErrMalformedRequest = errors.New("malformed request")

+ func Handler(r Runner, options ...HandlerOption) socket.Handler

+ type AllowedCommand struct

+ type Client struct

+ func NewClient(address string) *Client

+ func (c *Client) Close() error

+ func (c *Client) Run(ctx context.Context, req Request) <-chan Output

+ type Command struct

+ Args []string

+ Env map[string]string

+ Path string

+ Timeout time.Duration

+ WorkingDir string

+ func (c Command) LogValue() slog.Value

+ type HandlerOption func(*handlerConfig)

+ func WithLogger(logger *slog.Logger) HandlerOption

+ type Output struct

+ Data string

+ Error string

+ ExitCode int

+ Type OutputType

+ type OutputType string

+ const OutputError

+ const OutputResult

+ const OutputStderr

+ const OutputStdout

+ type Request struct

+ ClientID string

+ Command Command

+ RequestID string

+ type Response struct

+ ClientID string

+ Error string

+ Output Output

+ RequestID string

+ type Runner interface

+ Run func(ctx context.Context, w io.Writer, command Command) error

+ func NewRunner(options ...RunnerOption) Runner

+ type RunnerOption func(r *runner)

+ func WithAllowedCommands(commands map[string]AllowedCommand) RunnerOption

+ func WithWorkspaceRoot(root string) RunnerOption