commands

Documentation

Overview

Package commands contains functions that are exposed as dedicated commands of the tool.

Index

• type DownCommand
  • func (c *DownCommand) Run(s *options.Options) error
• type FixCommand
• type GetCommand
  • func (c *GetCommand) Run(s *options.Options) error
• type GuiCommand
  • func (c *GuiCommand) Run(s *options.Options) error
• type SSHCommand
  • func (c *SSHCommand) Run(s *options.Options) error
• type StatusCommand
  • func (*StatusCommand) Run(_ *options.Options) error
• type UpCommand
  • func (c *UpCommand) Run(s *options.Options) error
• type VersionCommand
  • func (*VersionCommand) Run(_ *options.Options) error

Types

type DownCommand

type DownCommand struct{}

DownCommand represents the options specific to the down command.

func (*DownCommand) Run

func (c *DownCommand) Run(s *options.Options) error

Run is the function for the down command.

type FixCommand

type FixCommand struct {
	CreateBridge createBridge `cmd:"create-bridge" aliases:"c" help:"Create bridge"`
	RemoveBridge removeBridge `cmd:"remove-bridge" aliases:"r" help:"Remove bridge"`
	ApplyLabels  applyLabels  `cmd:"apply-labels" aliases:"l" help:"Apply SELinux labels"`
	All          all          `cmd:"all" aliases:"a" help:"Create bridge and apply SELinux labels"`
}

FixCommand represents the options specific to the fix command.

type GetCommand

type GetCommand struct {
	Force  bool `short:"f" name:"force" help:"Force to download the new image"`
	Update bool `short:"u" name:"update" help:"Allow update to the latest image"`
}

GetCommand represents the options specific to the get command.

func (*GetCommand) Run

func (c *GetCommand) Run(s *options.Options) error

Run is the function for the get command.

type GuiCommand

type GuiCommand struct {
	Viewer     string `` /* 129-byte string literal not displayed */
	Fullscreen bool   `short:"f" name:"fullscreen" env:"HACKENV_FULLSCREEN" help:"Start GUI in fullscreen (virt-viewer only)"`
}

GuiCommand represents the options specific to the gui command.

func (*GuiCommand) Run

func (c *GuiCommand) Run(s *options.Options) error

Run is the function for the gui command.

type SSHCommand

type SSHCommand struct{}

SSHCommand represents the options specific to the ssh command.

func (*SSHCommand) Run

func (c *SSHCommand) Run(s *options.Options) error

Run is the function for the ssh command.

type StatusCommand

type StatusCommand struct{}

StatusCommand represents the options specific to the status command.

func (*StatusCommand) Run

func (*StatusCommand) Run(_ *options.Options) error

Run is the function for the status command.

type UpCommand

type UpCommand struct {
	Cores       int    `name:"cores" env:"HACKENV_CORES" default:"2" help:"How many virtual CPU cores to assign to the VM"`
	Memory      int    `name:"memory" env:"HACKENV_MEMORY" default:"2097152" help:"How much RAM to assign to the VM (KiB)"`
	Interface   string `name:"iface" env:"HACKENV_IFACE" default:"virbr0" help:"The network interface to use as a bridge"`
	DisplaySize string `name:"display_size" env:"HACKENV_DISPLAY_SIZE" default:"1920x1080" help:"The resolution of the VM's display"`
}

UpCommand represents the options specific to the up command.

func (*UpCommand) Run

func (c *UpCommand) Run(s *options.Options) error

Run is the function for the up command.

type VersionCommand

type VersionCommand struct{}

VersionCommand represents the options specific to the version command.

func (*VersionCommand) Run

func (*VersionCommand) Run(_ *options.Options) error

Run is the function for the version command.