commands

Documentation

Index

• Variables
• func Build(_ *flags.Build) error
• func BuildInfo(_ *BuildInfoOptions) error
• func Cp(_ *CpOptions) error
• func Dev(options *DevOptions) error
• func Doctor(_ *DoctorOptions) error
• func GenerateAppImage(options *GenerateAppImageOptions) error
• func GenerateBindings(options *flags.GenerateBindingsOptions, patterns []string) error
• func GenerateBuildAssets(options *BuildAssetsOptions) error
• func GenerateConstants(options *GenerateConstantsOptions) error
• func GenerateDotDesktop(options *DotDesktopOptions) error
• func GenerateIcons(options *IconsOptions) error
• func GenerateSyso(options *SysoOptions) (err error)
• func GenerateTemplateIcon(data []byte, outputFilename string) (err error)
• func Init(options *flags.Init) error
• func Package(_ *flags.Package) error
• func RunTask(options *RunTaskOptions, otherArgs []string) error
• func ServiceInit(options *flags.ServiceInit) error
• func ToolCheckPort(options *ToolCheckPortOptions) error
• func Version(_ *VersionOptions) error
• func Watcher(options *WatcherOptions) error
• type BuildAssetsOptions
• type BuildInfoOptions
• type CpOptions
• type DevOptions
• type DoctorOptions
• type DotDesktopOptions
• type GenerateAppImageOptions
• type GenerateConstantsOptions
• type IconsOptions
• type RunTaskOptions
• type SysoOptions
  • func (i *SysoOptions) Default() *SysoOptions
• type ToolCheckPortOptions
• type VersionOptions
• type WatcherOptions

Variables

var BuildSettings = map[string]string{}

BuildSettings contains the CLI build settings

var DisableFooter bool

Functions

func Build

func Build(_ *flags.Build) error

func BuildInfo

func BuildInfo(_ *BuildInfoOptions) error

func Cp

func Cp(_ *CpOptions) error

func Dev

func Dev(options *DevOptions) error

func Doctor

func Doctor(_ *DoctorOptions) error

func GenerateAppImage

func GenerateAppImage(options *GenerateAppImageOptions) error

func GenerateBindings

func GenerateBindings(options *flags.GenerateBindingsOptions, patterns []string) error

func GenerateBuildAssets

func GenerateBuildAssets(options *BuildAssetsOptions) error

func GenerateConstants

func GenerateConstants(options *GenerateConstantsOptions) error

func GenerateDotDesktop

func GenerateDotDesktop(options *DotDesktopOptions) error

func GenerateIcons

func GenerateIcons(options *IconsOptions) error

func GenerateSyso

func GenerateSyso(options *SysoOptions) (err error)

func GenerateTemplateIcon

func GenerateTemplateIcon(data []byte, outputFilename string) (err error)

func Init

func Init(options *flags.Init) error

func Package

func Package(_ *flags.Package) error

func RunTask

func RunTask(options *RunTaskOptions, otherArgs []string) error

func ServiceInit

func ServiceInit(options *flags.ServiceInit) error

func ToolCheckPort

func ToolCheckPort(options *ToolCheckPortOptions) error

func Version

func Version(_ *VersionOptions) error

func Watcher

func Watcher(options *WatcherOptions) error

Types

type BuildAssetsOptions

type BuildAssetsOptions struct {
	Dir                string `description:"The directory to generate the files into" default:"build"`
	Name               string `description:"The name of the project"`
	Binary             string `description:"The name of the binary"`
	ProductName        string `description:"The name of the product" default:"My Product"`
	ProductDescription string `description:"The description of the product" default:"My Product Description"`
	ProductVersion     string `description:"The version of the product" default:"0.1.0"`
	ProductCompany     string `description:"The company of the product" default:"My Company"`
	ProductCopyright   string `description:"The copyright notice" default:"\u00a9 now, My Company"`
	ProductComments    string `description:"Comments to add to the generated files" default:"This is a comment"`
	ProductIdentifier  string `description:"The product identifier, e.g com.mycompany.myproduct"`
	Silent             bool   `description:"Suppress output to console"`
}

type BuildInfoOptions

type BuildInfoOptions struct{}

type CpOptions

type CpOptions struct{}

type DevOptions

type DevOptions struct {
	flags.Common

	Config   string `description:"The config file including path" default:"./build/devmode.config.yaml"`
	VitePort int    `name:"port" description:"Specify the vite dev server port"`
	Secure   bool   `name:"s" description:"Enable HTTPS"`
}

type DoctorOptions

type DoctorOptions struct{}

type DotDesktopOptions

type DotDesktopOptions struct {
	OutputFile    string `description:"The output file to write to"`
	Type          string `description:"The type of the desktop entry" default:"Application"`
	Name          string `description:"The name of the application"`
	Exec          string `description:"The binary name + args to execute"`
	Icon          string `description:"The icon name or path for the application"`
	Categories    string `description:"Categories in which the application should be shown e.g. 'Development;IDE;'"`
	Comment       string `description:"A brief description of the application"`
	Terminal      bool   `description:"Whether the application runs in a terminal" default:"false"`
	Keywords      string `description:"Keywords associated with the application e.g. 'Editor;Image;'" default:"wails"`
	Version       string `description:"The version of the Desktop Entry Specification" default:"1.0"`
	GenericName   string `description:"A generic name for the application"`
	StartupNotify bool   `description:"If true, the app will send a notification when starting" default:"false"`
	MimeType      string `description:"The MIME types the application can handle e.g. 'image/gif;image/jpeg;'"`
}

type GenerateAppImageOptions

type GenerateAppImageOptions struct {
	Binary      string `description:"The binary to package including path"`
	Icon        string `description:"Path to the icon"`
	DesktopFile string `description:"Path to the desktop file"`
	OutputDir   string `description:"Path to the output directory" default:"."`
	BuildDir    string `description:"Path to the build directory"`
}

type GenerateConstantsOptions

type GenerateConstantsOptions struct {
	ConstantsFilename string `name:"f" description:"The filename for the models file" default:"constants.go"`
	OutputFilename    string `name:"o" description:"The output file" default:"constants.js"`
}

type IconsOptions

type IconsOptions struct {
	Example         bool   `description:"Generate example icon file (appicon.png) in the current directory"`
	Input           string `description:"The input image file"`
	Sizes           string `description:"The sizes to generate in .ico file (comma separated)" default:"256,128,64,48,32,16"`
	WindowsFilename string `description:"The output filename for the Windows icon" default:"icon.ico"`
	MacFilename     string `description:"The output filename for the Mac icon bundle" default:"icons.icns"`
}

type RunTaskOptions

type RunTaskOptions struct {
	Name             string `pos:"1"`
	Help             bool   `name:"h" description:"shows Task usage"`
	Init             bool   `name:"i" description:"creates a new Taskfile.yml"`
	List             bool   `name:"list" description:"tasks with description of current Taskfile"`
	ListAll          bool   `name:"list-all" description:"lists tasks with or without a description"`
	ListJSON         bool   `name:"json" description:"formats task list as json"`
	Status           bool   `name:"status" description:"exits with non-zero exit code if any of the given tasks is not up-to-date"`
	Force            bool   `name:"f" description:"forces execution even when the task is up-to-date"`
	Watch            bool   `name:"w" description:"enables watch of the given task"`
	Verbose          bool   `name:"v" description:"enables verbose mode"`
	Version          bool   `name:"version" description:"prints version"`
	Silent           bool   `name:"s" description:"disables echoing"`
	Parallel         bool   `name:"p" description:"executes tasks provided on command line in parallel"`
	Dry              bool   `name:"dry" description:"compiles and prints tasks in the order that they would be run, without executing them"`
	Summary          bool   `name:"summary" description:"show summary about a task"`
	ExitCode         bool   `name:"x" description:"pass-through the exit code of the task command"`
	Dir              string `name:"dir" description:"sets directory of execution"`
	EntryPoint       string `name:"taskfile" description:"choose which Taskfile to run."`
	OutputName       string `name:"output" description:"sets output style: [interleaved|group|prefixed]"`
	OutputGroupBegin string `name:"output-group-begin" description:"message template to print before a task's grouped output"`
	OutputGroupEnd   string `name:"output-group-end" description:"message template to print after a task's grouped output"`
	Color            bool   `name:"c" description:"colored output. Enabled by default. Set flag to false or use NO_COLOR=1 to disable" default:"true"`
	Concurrency      int    `name:"C" description:"limit number tasks to run concurrently"`
	Interval         int64  `name:"interval" description:"interval to watch for changes"`
}

type SysoOptions

type SysoOptions struct {
	Manifest string `description:"The manifest file"`
	Info     string `description:"The info.json file"`
	Icon     string `description:"The icon file"`
	Out      string `description:"The output filename for the syso file"`
	Arch     string `description:"The target architecture"`
}

func (*SysoOptions) Default

func (i *SysoOptions) Default() *SysoOptions

type ToolCheckPortOptions

type ToolCheckPortOptions struct {
	URL  string `name:"u" description:"URL to check"`
	Host string `name:"h" description:"Host to check" default:"localhost"`
	Port int    `name:"p" description:"Port to check"`
}

type VersionOptions

type VersionOptions struct{}

type WatcherOptions

type WatcherOptions struct {
	Config string `description:"The config file including path" default:"."`
}