commands

Documentation

Index

• func Build() *cli.Command
• func Bundle() *cli.Command
• func Env() *cli.Command
• func Get() *cli.Command
• func Install() *cli.Command
• func Package() *cli.Command
• func Release() *cli.Command
• func Serve() *cli.Command
• func Version() *cli.Command
• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) Build() error
• type Bundler
  • func NewBundler() *Bundler
  • func (b *Bundler) AddFlags()
  • func (b *Bundler) PrintHelp(indent string)
  • func (b *Bundler) Run(args []string)
• type Getter
  • func NewGetter() *Getter
  • func (g *Getter) AddFlags()
  • func (g *Getter) Get(pkg string) error
  • func (g *Getter) PrintHelp(indent string)
  • func (g *Getter) Run(args []string)
  • func (g *Getter) SetAppID(id string)
  • func (g *Getter) SetIcon(path string)
• type Installer
  • func NewInstaller() *Installer
  • func (i *Installer) AddFlags()
  • func (i *Installer) PrintHelp(indent string)
  • func (i *Installer) Run(args []string)
• type Packager
  • func NewPackager() *Packager
  • func (p *Packager) AddFlags()
  • func (p *Packager) Package() error
  • func (*Packager) PrintHelp(indent string)
  • func (p *Packager) Run(_ []string)
• type Releaser
  • func NewReleaser() *Releaser
  • func (r *Releaser) AddFlags()
  • func (r *Releaser) PrintHelp(indent string)
  • func (r *Releaser) Run(params []string)
• type Server
  • func (s *Server) Server(ctx *cli.Context) error

Functions

func Build

func Build() *cli.Command

Build returns the cli command for building fyne applications

func Bundle

func Bundle() *cli.Command

Bundle returns the vendor cli command

func Env

func Env() *cli.Command

Env returns the env command

func Get

func Get() *cli.Command

Get returns the command which downloads and installs fyne applications.

func Install

func Install() *cli.Command

Install returns the cli command for installing fyne applications

func Package

func Package() *cli.Command

Package returns the cli command for packaging fyne applications

func Release

func Release() *cli.Command

Release returns the cli command for bundling release builds of fyne applications

func Serve

func Serve() *cli.Command

Serve return the cli command for serving fyne wasm application over http

func Version

func Version() *cli.Command

Version returns the cli command for the program version.

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

Builder generate the executables.

func NewBuilder

func NewBuilder() *Builder

NewBuilder returns a command that can handle the build of GUI apps built using Fyne.

func (*Builder) Build

func (b *Builder) Build() error

Build parse the tags and start building

type Bundler

type Bundler struct {
	// contains filtered or unexported fields
}

Bundler bundles resources into Go code.

func NewBundler

func NewBundler() *Bundler

NewBundler returns a command that can handle the bundling assets into a GUI app binary.

func (*Bundler) AddFlags

func (b *Bundler) AddFlags()

AddFlags adds all the command line flags for passing to the Bundler.

Deprecated: Access to the individual cli commands are being removed.

func (*Bundler) PrintHelp

func (b *Bundler) PrintHelp(indent string)

PrintHelp prints the help message for the bundle command.

Deprecated: Access to the individual cli commands are being removed.

func (*Bundler) Run

func (b *Bundler) Run(args []string)

Run runs the bundle command.

Deprecated: A better version will be exposed in the future.

type Getter

type Getter struct {
	// contains filtered or unexported fields
}

Getter is the command that can handle downloading and installing Fyne apps to the current platform.

func NewGetter

func NewGetter() *Getter

NewGetter returns a command that can handle the download and install of GUI apps built using Fyne. It depends on a Go and C compiler installed at this stage.

func (*Getter) AddFlags

func (g *Getter) AddFlags()

AddFlags adds available flags to the current flags parser

Deprecated: Get does not define any flags.

func (*Getter) Get

func (g *Getter) Get(pkg string) error

Get automates the download and install of a named GUI app package.

func (*Getter) PrintHelp

func (g *Getter) PrintHelp(indent string)

PrintHelp prints help for this command when used in a command-line context

Deprecated: Use Get() to get the cli and help messages instead.

func (*Getter) Run

func (g *Getter) Run(args []string)

Run is the command-line version of the Get(pkg) command, the first of the passed arguments will be used as the package to get.

Deprecated: Use Get() for the urfave/cli command or Getter.Get() to download and install an application.

func (*Getter) SetAppID

func (g *Getter) SetAppID(id string)

SetAppID Allows the Get operation to specify an appID for the application that is being downloaded.

Since: 2.1

func (*Getter) SetIcon

func (g *Getter) SetIcon(path string)

SetIcon allows you to set the app icon path that will be used for the next Get operation.

type Installer

type Installer struct {
	Packager *Packager
	// contains filtered or unexported fields
}

Installer installs locally built Fyne apps.

func NewInstaller

func NewInstaller() *Installer

NewInstaller returns a command that can install a GUI apps built using Fyne from local source code.

func (*Installer) AddFlags

func (i *Installer) AddFlags()

AddFlags adds the flags for interacting with the Installer.

Deprecated: Access to the individual cli commands are being removed.

func (*Installer) PrintHelp

func (i *Installer) PrintHelp(indent string)

PrintHelp prints the help for the install command.

Deprecated: Access to the individual cli commands are being removed.

func (*Installer) Run

func (i *Installer) Run(args []string)

Run runs the install command.

Deprecated: A better version will be exposed in the future.

type Packager

type Packager struct {
	// contains filtered or unexported fields
}

Packager wraps executables into full GUI app packages.

func NewPackager

func NewPackager() *Packager

NewPackager returns a command that can handle the packaging a GUI apps built using Fyne from local source code.

func (*Packager) AddFlags

func (p *Packager) AddFlags()

AddFlags adds the flags for interacting with the package command.

Deprecated: Access to the individual cli commands are being removed.

func (*Packager) Package

func (p *Packager) Package() error

Package starts the packaging process

func (*Packager) PrintHelp

func (*Packager) PrintHelp(indent string)

PrintHelp prints the help for the package command.

Deprecated: Access to the individual cli commands are being removed.

func (*Packager) Run

func (p *Packager) Run(_ []string)

Run runs the package command.

Deprecated: A better version will be exposed in the future.

type Releaser

type Releaser struct {
	Packager
	// contains filtered or unexported fields
}

Releaser adapts app packages form distribution.

func NewReleaser

func NewReleaser() *Releaser

NewReleaser returns a command that can handle the packaging a GUI apps for release from local Fyne source code.

func (*Releaser) AddFlags

func (r *Releaser) AddFlags()

AddFlags adds the flags for interacting with the release command.

Deprecated: Access to the individual cli commands are being removed.

func (*Releaser) PrintHelp

func (r *Releaser) PrintHelp(indent string)

PrintHelp prints the help message for the release command.

Deprecated: Access to the individual cli commands are being removed.

func (*Releaser) Run

func (r *Releaser) Run(params []string)

Run runs the release command.

Deprecated: A better version will be exposed in the future.

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server serve fyne wasm application over http

func (*Server) Server

func (s *Server) Server(ctx *cli.Context) error

Server serve the wasm application over http