command

Documentation

Index

• func AppendEnv(args []string, environs map[string]string, quoteNeeded bool) []string
• func NewAndroidCommand() *android
• func NewDarwinCommand() *darwin
• func NewFreeBSD() *freeBSD
• func NewIOSCommand() *iOS
• func NewLinuxCommand() *linux
• func NewWebCommand() *web
• func NewWindowsCommand() *windows
• func Usage(commands []Command)
• type Architecture
  • func (a Architecture) String() string
• type Command
• type CommonFlags
• type Context
  • func (ctx Context) String() string
• type DarwinSDKExtract
  • func (cmd *DarwinSDKExtract) Description() string
  • func (cmd *DarwinSDKExtract) Name() string
  • func (cmd *DarwinSDKExtract) Parse(args []string) error
  • func (cmd *DarwinSDKExtract) Run() error
  • func (cmd *DarwinSDKExtract) Usage()
• type Engine
  • func MakeEngine(e string) (Engine, error)
  • func (e Engine) IsDocker() bool
  • func (e Engine) IsKubernetes() bool
  • func (e Engine) IsPodman() bool
  • func (e Engine) String() string
• type Version
  • func (cmd *Version) Description() string
  • func (cmd *Version) Name() string
  • func (cmd *Version) Parse(args []string) error
  • func (cmd *Version) Run() error
  • func (cmd *Version) Usage()

Functions

func AppendEnv

func AppendEnv(args []string, environs map[string]string, quoteNeeded bool) []string

func NewAndroidCommand

func NewAndroidCommand() *android

func NewDarwinCommand

func NewDarwinCommand() *darwin

func NewFreeBSD

func NewFreeBSD() *freeBSD

func NewIOSCommand

func NewIOSCommand() *iOS

func NewLinuxCommand

func NewLinuxCommand() *linux

func NewWebCommand

func NewWebCommand() *web

func NewWindowsCommand

func NewWindowsCommand() *windows

func Usage

func Usage(commands []Command)

Usage prints the fyne-cross command usage

Types

type Architecture

type Architecture string

Architecture represents the Architecture type

const (
	// ArchAmd64 represents the amd64 architecture
	ArchAmd64 Architecture = "amd64"
	// Arch386 represents the amd64 architecture
	Arch386 Architecture = "386"
	// ArchArm64 represents the arm64 architecture
	ArchArm64 Architecture = "arm64"
	// ArchArm represents the arm architecture
	ArchArm Architecture = "arm"
	// ArchMultiple represents the universal architecture used by some OS to
	// identify a binary that supports multiple architectures (fat binary)
	ArchMultiple Architecture = "multiple"
)

func (Architecture) String

func (a Architecture) String() string

type Command

type Command interface {
	Name() string              // Name returns the one word command name
	Description() string       // Description returns the command description
	Parse(args []string) error // Parse parses the cli arguments
	Usage()                    // Usage displays the command usage
	Run() error                // Run runs the command
}

Command wraps the methods for a fyne-cross command

type CommonFlags

type CommonFlags struct {
	// AppBuild represents the build number, should be greater than 0 and
	// incremented for each build
	AppBuild int
	// AppID represents the application ID used for distribution
	AppID string
	// AppVersion represents the version number in the form x, x.y or x.y.z semantic version
	AppVersion string
	// CacheDir is the directory used to share/cache sources and dependencies.
	// Default to system cache directory (i.e. $HOME/.cache/fyne-cross)
	CacheDir string
	// DockerImage represents a custom docker image to use for build
	DockerImage string
	// Engine is the container engine to use
	Engine engineFlag
	// Namespace used by Kubernetes engine to run its pod in
	Namespace string
	// Base S3 directory to push and pull data from
	S3Path string
	// Container mount point size limits honored by Kubernetes only
	SizeLimit string
	// Env is the list of custom env variable to set. Specified as "KEY=VALUE"
	Env envFlag
	// Icon represents the application icon used for distribution
	Icon string
	// Ldflags represents the flags to pass to the external linker
	Ldflags string
	// Additional build tags
	Tags tagsFlag
	// Metadata contain custom metadata passed to fyne package
	Metadata multiFlags
	// NoCache if true will not use the go build cache
	NoCache bool
	// NoProjectUpload if true, the build will be done with the artifact already stored on S3
	NoProjectUpload bool
	// NoResultDownload if true, it will leave the result of the build on S3 and won't download it locally (engine: kubernetes)
	NoResultDownload bool
	// NoStripDebug if true will not strip debug information from binaries
	NoStripDebug bool
	// NoNetwork if true will not setup network inside the container
	NoNetwork bool
	// Name represents the application name
	Name string
	// Release represents if the package should be prepared for release (disable debug etc)
	Release bool
	// RootDir represents the project root directory
	RootDir string
	// Silent enables the silent mode
	Silent bool
	// Debug enables the debug mode
	Debug bool
	// Pull attempts to pull a newer version of the docker image
	Pull bool
	// DockerRegistry changes the pull/push docker registry (defualt docker.io)
	DockerRegistry string
}

CommonFlags holds the flags shared between all commands

type Context

type Context struct {
	// Volume holds the mounted volumes between host and containers
	volume.Volume

	Engine    Engine            // Engine is the container engine to use
	Namespace string            // Namespace used by Kubernetes engine to run its pod in
	S3Path    string            // Project base directory to use to push and pull data from S3
	SizeLimit string            // Container mount point size limits honored by Kubernetes only
	Env       map[string]string // Env is the list of custom env variable to set. Specified as "KEY=VALUE"
	Tags      []string          // Tags defines the tags to use
	Metadata  map[string]string // Metadata contain custom metadata passed to fyne package

	AppBuild         string // Build number
	AppID            string // AppID is the appID to use for distribution
	AppVersion       string // AppVersion is the version number in the form x, x.y or x.y.z semantic version
	CacheEnabled     bool   // CacheEnabled if true enable go build cache
	Icon             string // Icon is the optional icon in png format to use for distribution
	Name             string // Name is the application name
	Package          string // Package is the package to build named by the import path as per 'go build'
	Release          bool   // Enable release mode. If true, prepares an application for public distribution
	StripDebug       bool   // StripDebug if true, strips binary output
	Debug            bool   // Debug if true enable debug log
	Pull             bool   // Pull if true attempts to pull a newer version of the docker image
	NoProjectUpload  bool   // NoProjectUpload if true, the build will be done with the artifact already stored on S3
	NoResultDownload bool   // NoResultDownload if true, the result of the build will be left on S3 and not downloaded locally
	NoNetwork        bool   // NoNetwork if true, the build will be done without network access

	//Build context
	BuildMode string // The -buildmode argument to pass to go build

	// Release context
	Category     string //Category represents the category of the app for store listing [macOS]
	Certificate  string //Certificate represents the name of the certificate to sign the build [iOS, Windows]
	Developer    string //Developer represents the developer identity for your Microsoft store account [Windows]
	Keystore     string //Keystore represents the location of .keystore file containing signing information [Android]
	KeystorePass string //KeystorePass represents the password for the .keystore file [Android]
	KeyPass      string //KeyPass represents the assword for the signer's private key, which is needed if the private key is password-protected [Android]
	Password     string //Password represents the password for the certificate used to sign the build [Windows]
	Profile      string //Profile represents the name of the provisioning profile for this release build [iOS]
}

Context represent a build context

func (Context) String

func (ctx Context) String() string

String implements the Stringer interface

type DarwinSDKExtract

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

DarwinSDKExtract extracts the macOS SDK from the Command Line Tools for Xcode package

func (*DarwinSDKExtract) Description

func (cmd *DarwinSDKExtract) Description() string

Description returns the command description

func (*DarwinSDKExtract) Name

func (cmd *DarwinSDKExtract) Name() string

Name returns the one word command name

func (*DarwinSDKExtract) Parse

func (cmd *DarwinSDKExtract) Parse(args []string) error

Parse parses the arguments and set the usage for the command

func (*DarwinSDKExtract) Run

func (cmd *DarwinSDKExtract) Run() error

Run runs the command

func (*DarwinSDKExtract) Usage

func (cmd *DarwinSDKExtract) Usage()

Usage displays the command usage

type Engine

type Engine struct {
	Name   string
	Binary string
}

func MakeEngine

func MakeEngine(e string) (Engine, error)

MakeEngine returns a new container engine. Pass empty string to autodetect

func (Engine) IsDocker

func (e Engine) IsDocker() bool

func (Engine) IsKubernetes

func (e Engine) IsKubernetes() bool

func (Engine) IsPodman

func (e Engine) IsPodman() bool

func (Engine) String

func (e Engine) String() string

type Version

type Version struct{}

Version is the version command

func (*Version) Description

func (cmd *Version) Description() string

Description returns the command description

func (*Version) Name

func (cmd *Version) Name() string

Name returns the one word command name

func (*Version) Parse

func (cmd *Version) Parse(args []string) error

Parse parses the arguments and set the usage for the command

func (*Version) Run

func (cmd *Version) Run() error

Run runs the command

func (*Version) Usage

func (cmd *Version) Usage()

Usage displays the command usage