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
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

v1

v1.4.0

Jul 24, 2025

v1.3.0

Jul 24, 2025

v1.2.0

Jul 24, 2025

v1.1.3

Jul 24, 2025

Changes in this version

+ type DockerComposeFindCommand struct

+ func NewDockerComposeFindCommand() *DockerComposeFindCommand

+ func (c *DockerComposeFindCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type DockerComposeViewCommand struct

+ func NewDockerComposeViewCommand() *DockerComposeViewCommand

+ func (c *DockerComposeViewCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

v1.1.2

Jul 2, 2025

v1.1.0

Jul 2, 2025

v0

v0.1.1

Jul 1, 2025

Changes in this version

+ const MaxFileSize

+ const MaxPreviewSize

+ type BaseCommand struct

+ func NewBaseCommand(name, category, description, usage string) *BaseCommand

+ func (b *BaseCommand) CreateErrorResult(ctx *ExecutionContext, err error) *pb.CommandResult

+ func (b *BaseCommand) CreateErrorResultWithCode(ctx *ExecutionContext, err error, exitCode int32) *pb.CommandResult

+ func (b *BaseCommand) CreateSuccessResult(ctx *ExecutionContext, output string) *pb.CommandResult

+ func (b *BaseCommand) Metadata() Definition

+ func (b *BaseCommand) WithExamples(examples ...Example) *BaseCommand

+ func (b *BaseCommand) WithNotes(notes ...string) *BaseCommand

+ func (b *BaseCommand) WithParameters(params ...Param) *BaseCommand

+ type CopyMoveResponse struct

+ BytesCopied int64

+ Destination string

+ Duration string

+ FilesCount int

+ Source string

+ type Definition struct

+ Category string

+ Description string

+ Examples []Example

+ Name string

+ Notes []string

+ Parameters []Param

+ Usage string

+ type DockerComposeCommand struct

+ func NewDockerComposeCommand() *DockerComposeCommand

+ func (c *DockerComposeCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type DockerComposeDownCommand struct

+ func NewDockerComposeDownCommand() *DockerComposeDownCommand

+ func (c *DockerComposeDownCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type DockerComposePSCommand struct

+ func NewDockerComposePSCommand() *DockerComposePSCommand

+ func (c *DockerComposePSCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type DockerComposeRequest struct

+ Build bool

+ Command string

+ Path string

+ Service string

+ type DockerComposeUpCommand struct

+ func NewDockerComposeUpCommand() *DockerComposeUpCommand

+ func (c *DockerComposeUpCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type Example struct

+ Command string

+ Description string

+ Expected string

+ type ExecutableCommand interface

+ Execute func(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ Metadata func() Definition

+ type ExecutionContext struct

+ AtomicLevel *zap.AtomicLevel

+ CommandID string

+ Context context.Context

+ Logger *zap.Logger

+ MinionID string

+ Timestamp int64

+ func NewExecutionContext(ctx context.Context, logger *zap.Logger, atom *zap.AtomicLevel, ...) *ExecutionContext

+ type FileCommandType string

+ const CmdCopy

+ const CmdGet

+ const CmdInfo

+ const CmdMove

+ type FileCopyCommand struct

+ func NewFileCopyCommand() *FileCopyCommand

+ func (c *FileCopyCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type FileGetCommand struct

+ func NewFileGetCommand() *FileGetCommand

+ func (c *FileGetCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type FileInfo struct

+ Checksum string

+ ContentType string

+ Group string

+ IsDir bool

+ ModTime time.Time

+ Mode os.FileMode

+ Name string

+ Owner string

+ Path string

+ Permissions string

+ Size int64

+ type FileInfoCommand struct

+ func NewFileInfoCommand() *FileInfoCommand

+ func (c *FileInfoCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type FileMoveCommand struct

+ func NewFileMoveCommand() *FileMoveCommand

+ func (c *FileMoveCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type FileOptions struct

+ CreateDirs bool

+ MaxSize int64

+ Overwrite bool

+ PreservePerm bool

+ type FileRequest struct

+ Command FileCommandType

+ Destination string

+ Options FileOptions

+ Recursive bool

+ Source string

+ type GetResponse struct

+ Content []byte

+ ContentB64 string

+ FileInfo FileInfo

+ PreviewOnly bool

+ Truncated bool

+ type InfoResponse struct

+ Children []FileInfo

+ FileInfo FileInfo

+ type LoggingDecreaseCommand struct

+ func NewLoggingDecreaseCommand() *LoggingDecreaseCommand

+ func (c *LoggingDecreaseCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type LoggingIncreaseCommand struct

+ func NewLoggingIncreaseCommand() *LoggingIncreaseCommand

+ func (c *LoggingIncreaseCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type LoggingLevelCommand struct

+ func NewLoggingLevelCommand() *LoggingLevelCommand

+ func (c *LoggingLevelCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type Param struct

+ Default string

+ Description string

+ Name string

+ Required bool

+ Type string

+ type Registry struct

+ func NewRegistry() *Registry

+ func SetupCommands(shellTimeout time.Duration) *Registry

+ func (r *Registry) Execute(ctx *ExecutionContext, command *pb.Command) (*pb.CommandResult, error)

+ func (r *Registry) FormatCommandHelp(commandName string) string

+ func (r *Registry) FormatHelp() string

+ func (r *Registry) GetAllCommands() map[string]ExecutableCommand

+ func (r *Registry) GetCommand(name string) (ExecutableCommand, bool)

+ func (r *Registry) GetCommandsByCategory() map[string][]ExecutableCommand

+ func (r *Registry) Register(cmd ExecutableCommand)

+ type ShellCommand struct

+ func NewShellCommand(defaultTimeout time.Duration) *ShellCommand

+ func (c *ShellCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type ShellExecutor struct

+ func NewShellExecutor(defaultTimeout time.Duration) *ShellExecutor

+ func (se *ShellExecutor) Execute(ctx context.Context, request *ShellRequest) *ShellResponse

+ type ShellRequest struct

+ Command string

+ Shell string

+ Timeout int

+ func ParseShellRequest(payload string) (*ShellRequest, error)

+ type ShellResponse struct

+ Command string

+ Duration string

+ ExitCode int32

+ Shell string

+ Stderr string

+ Stdout string

+ TimedOut bool

+ Timestamp int64

+ type SystemCommand struct

+ func NewSystemCommand(defaultTimeout time.Duration) *SystemCommand

+ func (c *SystemCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type SystemInfoCommand struct

+ func NewSystemInfoCommand() *SystemInfoCommand

+ func (c *SystemInfoCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type SystemOSCommand struct

+ func NewSystemOSCommand() *SystemOSCommand

+ func (c *SystemOSCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)

+ type UnifiedFileCommand struct

+ func NewFileCommand() *UnifiedFileCommand

+ func (c *UnifiedFileCommand) Execute(ctx *ExecutionContext, payload string) (*pb.CommandResult, error)