Documentation
¶
Index ¶
- Variables
- func AndroidOverlayGen(options *AndroidOverlayGenOptions) error
- func Build(buildFlags *flags.Build, otherArgs []string) error
- func BuildInfo(_ *BuildInfoOptions) error
- func CopyFile(source string, target string) error
- func Cp(_ *CpOptions) error
- func Dev(options *DevOptions) error
- func Doctor(options *flags.Doctor) error
- func DoctorNg(options *DoctorNgOptions) error
- func EntitlementsSetup(options *flags.EntitlementsSetup) 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 GenerateRuntime(options *RuntimeOptions) error
- func GenerateSyso(options *SysoOptions) (err error)
- func GenerateTemplate(options *templates.BaseTemplate) error
- func GenerateTemplateIcon(data []byte, outputFilename string) (err error)
- func GenerateWebView2Bootstrapper(options *GenerateWebView2Options) error
- func IOSOverlayGen(options *IOSOverlayGenOptions) error
- func IOSOverlayGenCmd() error
- func IOSXcodeGen(options *IOSXcodeGenOptions) error
- func IOSXcodeGenCmd() error
- func Init(options *flags.Init) error
- func InstallMSIXTools() error
- func MCP(options *MCPOptions) error
- func Package(_ *flags.Package, otherArgs []string) error
- func ReleaseNotes(options *ReleaseNotesOptions) error
- func RunTask(options *RunTaskOptions, otherArgs []string) error
- func ServiceInit(options *flags.ServiceInit) error
- func Setup(_ *SetupOptions) error
- func Sign(options *flags.Sign) error
- func SignWrapper(_ *flags.SignWrapper, otherArgs []string) error
- func SigningSetup(options *flags.SigningSetup) error
- func ToolCapabilities(_ *ToolCapabilitiesOptions) error
- func ToolCheckPort(options *ToolCheckPortOptions) error
- func ToolDockerMounts(_ *DockerMountsOptions) error
- func ToolHas(opts *HasOptions) error
- func ToolHasCC(_ *HasCCOptions) error
- func ToolLipo(options *flags.Lipo) error
- func ToolMSIX(options *flags.ToolMSIX) error
- func ToolPackage(options *flags.ToolPackage) error
- func ToolVersion(options *ToolVersionOptions) error
- func UpdateBuildAssets(options *UpdateBuildAssetsOptions) error
- func UpdateCLI(options *UpdateCLIOptions) error
- func UpdaterGenKey(options *UpdaterGenKeyOptions) error
- func UpdaterManifest(options *UpdaterManifestOptions, args []string) error
- func UpdaterSign(options *UpdaterSignOptions, files []string) error
- func UpdaterVerify(options *UpdaterVerifyOptions) error
- func Version(_ *VersionOptions) error
- func Watcher(options *WatcherOptions) error
- type AndroidOverlayGenOptions
- type BuildAssetsOptions
- type BuildConfig
- type BuildInfoOptions
- type Capabilities
- type CpOptions
- type DevOptions
- type DockerMountsOptions
- type DoctorNgOptions
- type DotDesktopOptions
- type Entitlement
- type FileAssociation
- type GenerateAppImageOptions
- type GenerateConstantsOptions
- type GenerateWebView2Options
- type HasCCOptions
- type HasOptions
- type IOSOverlayGenOptions
- type IOSXcodeGenOptions
- type IconsOptions
- type LinuxCapabilities
- type MCPOptions
- type MSIXOptions
- type ProtocolConfig
- type ReleaseNotesOptions
- type RunTaskOptions
- type RuntimeOptions
- type SetupOptions
- type SysoOptions
- type TemplateEnrichment
- type ToolCapabilitiesOptions
- type ToolCheckPortOptions
- type ToolVersionOptions
- type UpdateBuildAssetsOptions
- type UpdateCLIOptions
- type UpdateConfig
- type UpdaterGenKeyOptions
- type UpdaterManifestOptions
- type UpdaterSignOptions
- type UpdaterVerifyOptions
- type VersionOptions
- type WailsConfig
- type WatcherOptions
Constants ¶
This section is empty.
Variables ¶
var BuildSettings = map[string]string{}
BuildSettings contains the CLI build settings
Functions ¶
func AndroidOverlayGen ¶
func AndroidOverlayGen(options *AndroidOverlayGenOptions) error
AndroidOverlayGen generates a Go build overlay JSON that injects a generated main_android.gen.go into the application's main package. That file's init() calls application.RegisterAndroidMain(main), which the c-shared library needs because main() is not invoked automatically in -buildmode=c-shared.
This mirrors the iOS overlay (see IOSOverlayGen): the file is injected virtually via the overlay so the user's project root stays clean.
It writes:
- <Out> : overlay JSON file
- <dir>/gen/main_android.gen.go : the generated Go file referenced by the overlay
The overlay maps <appDir>/main_android.gen.go -> <dir>/gen/main_android.gen.go
func BuildInfo ¶
func BuildInfo(_ *BuildInfoOptions) error
func Dev ¶
func Dev(options *DevOptions) error
func DoctorNg ¶
func DoctorNg(options *DoctorNgOptions) error
func EntitlementsSetup ¶
func EntitlementsSetup(options *flags.EntitlementsSetup) error
EntitlementsSetup runs the interactive entitlements configuration wizard
func GenerateAppImage ¶
func GenerateAppImage(options *GenerateAppImageOptions) error
func GenerateBindings ¶
func GenerateBindings(options *flags.GenerateBindingsOptions, patterns []string) error
func GenerateBuildAssets ¶
func GenerateBuildAssets(options *BuildAssetsOptions) error
GenerateBuildAssets generates the build assets for the project.
func GenerateConstants ¶
func GenerateConstants(options *GenerateConstantsOptions) error
func GenerateDotDesktop ¶
func GenerateDotDesktop(options *DotDesktopOptions) error
func GenerateIcons ¶
func GenerateIcons(options *IconsOptions) error
func GenerateRuntime ¶
func GenerateRuntime(options *RuntimeOptions) error
func GenerateSyso ¶
func GenerateSyso(options *SysoOptions) (err error)
func GenerateTemplate ¶
func GenerateTemplate(options *templates.BaseTemplate) error
func GenerateTemplateIcon ¶
func GenerateWebView2Bootstrapper ¶
func GenerateWebView2Bootstrapper(options *GenerateWebView2Options) error
func IOSOverlayGen ¶
func IOSOverlayGen(options *IOSOverlayGenOptions) error
IOSOverlayGen generates a Go build overlay JSON that injects a generated main_ios.gen.go exporting WailsIOSMain() which calls main().
It writes: - <Out> : overlay JSON file - <dir>/gen/main_ios.gen.go : the generated Go file referenced by the overlay
The overlay maps <appDir>/main_ios.gen.go -> <dir>/gen/main_ios.gen.go
func IOSOverlayGenCmd ¶
func IOSOverlayGenCmd() error
IOSOverlayGenCmd is a CLI entry compatible with NewSubCommandFunction. Defaults:
config: ./build/config.yml (optional) out: ./build/ios/xcode/overlay.json
func IOSXcodeGen ¶
func IOSXcodeGen(options *IOSXcodeGenOptions) error
IOSXcodeGen generates an Xcode project skeleton for the current app.
func IOSXcodeGenCmd ¶
func IOSXcodeGenCmd() error
IOSXcodeGenCmd is a CLI entry compatible with NewSubCommandFunction. Defaults:
config: ./build/config.yml (optional) out: ./build/ios/xcode
func InstallMSIXTools ¶
func InstallMSIXTools() error
InstallMSIXTools installs the required tools for MSIX packaging
func MCP ¶
func MCP(options *MCPOptions) error
MCP starts a local MCP server. Transport is selected automatically: stdio when no terminal is attached and loopback Streamable HTTP when run interactively. The token is returned in the MCP initialize instructions so an agent can use it without contaminating the JSON-RPC stdout stream. It is also written to stderr for humans debugging a manually launched server.
func ReleaseNotes ¶
func ReleaseNotes(options *ReleaseNotesOptions) error
func RunTask ¶
func RunTask(options *RunTaskOptions, otherArgs []string) error
func ServiceInit ¶
func ServiceInit(options *flags.ServiceInit) error
func Setup ¶
func Setup(_ *SetupOptions) error
func SignWrapper ¶
func SignWrapper(_ *flags.SignWrapper, otherArgs []string) error
func SigningSetup ¶
func SigningSetup(options *flags.SigningSetup) error
SigningSetup configures signing variables in platform Taskfiles
func ToolCapabilities ¶
func ToolCapabilities(_ *ToolCapabilitiesOptions) error
func ToolCheckPort ¶
func ToolCheckPort(options *ToolCheckPortOptions) error
func ToolDockerMounts ¶
func ToolDockerMounts(_ *DockerMountsOptions) error
ToolDockerMounts outputs Docker volume mount flags for cross-compilation. It generates mounts for the Go module cache and any local replace directives in go.mod. This is a cross-platform replacement for the bash pipeline that was previously used in Taskfile templates.
The project is assumed to be mounted at /app inside the container (matching the Taskfile `docker run -v "{{.ROOT_DIR}}:/app"` convention). Each -v flag is double-quoted so paths with spaces survive shell tokenisation in both POSIX sh and cmd.exe (go-task may use either on Windows).
func ToolHas ¶
func ToolHas(opts *HasOptions) error
ToolHas checks if a given tool (or any of several pipe-separated tools) is available in PATH. Outputs "true" or "false" for use in Taskfile sh: variables.
func ToolHasCC ¶
func ToolHasCC(_ *HasCCOptions) error
ToolHasCC is a deprecated alias for `wails3 tool has gcc|clang`.
func ToolPackage ¶
func ToolPackage(options *flags.ToolPackage) error
ToolPackage generates a package in the specified format
func ToolVersion ¶
func ToolVersion(options *ToolVersionOptions) error
ToolVersion bumps a semantic version based on the provided flags
func UpdateBuildAssets ¶
func UpdateBuildAssets(options *UpdateBuildAssetsOptions) error
UpdateBuildAssets updates the build assets for the project.
func UpdateCLI ¶
func UpdateCLI(options *UpdateCLIOptions) error
func UpdaterGenKey ¶
func UpdaterGenKey(options *UpdaterGenKeyOptions) error
UpdaterGenKey generates an Ed25519 keypair for signing update artifacts.
func UpdaterManifest ¶
func UpdaterManifest(options *UpdaterManifestOptions, args []string) error
UpdaterManifest generates an update manifest for the given artifact files or directories, computing digests and (when a key is provided) signatures.
func UpdaterSign ¶
func UpdaterSign(options *UpdaterSignOptions, files []string) error
UpdaterSign signs one or more artifact files and prints the digests and signatures as JSON.
func UpdaterVerify ¶
func UpdaterVerify(options *UpdaterVerifyOptions) error
UpdaterVerify re-checks every artifact in a manifest against the files on disk: recomputes digests and verifies signatures with the public key, exactly as a shipped application would. Intended as a CI gate before publishing.
func Version ¶
func Version(_ *VersionOptions) error
func Watcher ¶
func Watcher(options *WatcherOptions) error
Types ¶
type AndroidOverlayGenOptions ¶
type AndroidOverlayGenOptions struct {
Out string `description:"Path to write overlay.json" default:"build/android/overlay.json"`
Config string `description:"Path to build/config.yml (optional)" default:"build/config.yml"`
}
AndroidOverlayGenOptions holds parameters for Android overlay generation.
type BuildAssetsOptions ¶
type BuildAssetsOptions struct {
Dir string `description:"The directory to generate the files into" default:"."`
Name string `description:"The name of the project"`
BinaryName 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"`
CFBundleIconName string `description:"The macOS icon name (for Assets.car icon bundles)"`
MinIOSVersion string `description:"Minimum iOS version for the generated Info.plist" default:"15.0"`
Publisher string `description:"Publisher name for MSIX package (e.g., CN=CompanyName)"`
ProcessorArchitecture string `description:"Processor architecture for MSIX package" default:"x64"`
ExecutablePath string `description:"Path to executable for MSIX package"`
ExecutableName string `description:"Name of executable for MSIX package"`
OutputPath string `description:"Output path for MSIX package"`
CertificatePath string `description:"Certificate path for MSIX package"`
Silent bool `description:"Suppress output to console"`
Typescript bool `description:"Use typescript" default:"false"`
UseInterfaces bool `description:"Generate TypeScript interfaces instead of classes"`
}
BuildAssetsOptions defines the options for generating build assets.
type BuildConfig ¶
type BuildConfig struct {
BuildAssetsOptions
TemplateEnrichment
FileAssociations []FileAssociation `yaml:"fileAssociations"`
Protocols []ProtocolConfig `yaml:"protocols,omitempty"`
}
BuildConfig defines the configuration for generating build assets.
type BuildInfoOptions ¶
type BuildInfoOptions struct{}
type Capabilities ¶
type Capabilities struct {
Platform string `json:"platform"`
Arch string `json:"arch"`
Linux *LinuxCapabilities `json:"linux,omitempty"`
}
type DevOptions ¶
type DockerMountsOptions ¶
type DockerMountsOptions struct{}
DockerMountsOptions holds options for the docker-mounts command.
type DoctorNgOptions ¶
type DoctorNgOptions struct {
NonInteractive bool `name:"n" description:"Run in non-interactive mode (no TUI)"`
}
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 Entitlement ¶
Entitlement represents a macOS entitlement
type FileAssociation ¶
type FileAssociation struct {
Ext string `yaml:"ext"`
Name string `yaml:"name"`
Description string `yaml:"description"`
IconName string `yaml:"iconName"`
Role string `yaml:"role"`
MimeType string `yaml:"mimeType"`
}
FileAssociation defines the structure for a file association.
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 GenerateWebView2Options ¶
type GenerateWebView2Options struct {
Directory string `name:"dir" json:"directory"`
}
type HasCCOptions ¶
type HasCCOptions struct{}
HasCCOptions holds options for the deprecated has-cc command.
type HasOptions ¶
type HasOptions struct {
Tool string `pos:"1" name:"tool" description:"Tool(s) to check for in PATH. Use | to check for any of multiple tools (e.g. gcc|clang)"`
}
HasOptions holds options for the has command.
type IOSOverlayGenOptions ¶
type IOSOverlayGenOptions struct {
Out string `description:"Path to write overlay.json" default:"build/ios/xcode/overlay.json"`
Config string `description:"Path to build/config.yml (optional)" default:"build/config.yml"`
}
IOSOverlayGenOptions holds parameters for overlay generation.
type IOSXcodeGenOptions ¶
type IOSXcodeGenOptions struct {
OutDir string `description:"Output directory for generated Xcode project" default:"build/ios/xcode"`
Config string `description:"Path to build/config.yml (optional)" default:"build/config.yml"`
}
IOSXcodeGenOptions holds parameters for Xcode project generation.
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" default:"build/appicon.png"`
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:"build/windows/icon.ico"`
MacFilename string `description:"The output filename for the Mac icon bundle" default:"build/darwin/icon.icns"`
IconComposerInput string `description:"The input Icon Composer file (.icon)"`
MacAssetDir string `description:"The output directory for the Mac assets (Assets.car and icons.icns)"`
}
type LinuxCapabilities ¶
type MCPOptions ¶
type MCPOptions struct {
Token string `name:"token" description:"Bearer token for mutating and process-control tools"`
Root string `name:"root" description:"Allowed project root (defaults to the current directory)"`
HTTP bool `name:"http" description:"Use Streamable HTTP instead of automatic transport selection"`
Stdio bool `name:"stdio" description:"Use stdio instead of automatic transport selection"`
Port int `name:"port" description:"HTTP port (0 chooses a free loopback port)" default:"0"`
}
MCPOptions configures the local project MCP server. Transport is selected automatically: stdio when launched by an agent (no terminal) and loopback Streamable HTTP when run interactively. Both modes can be forced explicitly.
type MSIXOptions ¶
type MSIXOptions struct {
// Info from project config
Info struct {
CompanyName string `json:"companyName"`
ProductName string `json:"productName"`
ProductVersion string `json:"version"`
ProductIdentifier string `json:"productIdentifier"`
Description string `json:"description"`
Copyright string `json:"copyright"`
Comments string `json:"comments"`
}
// File associations
FileAssociations []struct {
Ext string `json:"ext"`
Name string `json:"name"`
Description string `json:"description"`
IconName string `json:"iconName"`
Role string `json:"role"`
MimeType string `json:"mimeType,omitempty"`
} `json:"fileAssociations"`
// MSIX specific options
Publisher string `json:"publisher"`
CertificatePath string `json:"certificatePath"`
CertificatePassword string `json:"certificatePassword,omitempty"`
ProcessorArchitecture string `json:"processorArchitecture"`
ExecutableName string `json:"executableName"`
ExecutablePath string `json:"executablePath"`
OutputPath string `json:"outputPath"`
UseMsixPackagingTool bool `json:"useMsixPackagingTool"`
UseMakeAppx bool `json:"useMakeAppx"`
}
MSIXOptions represents the configuration for MSIX packaging
type ProtocolConfig ¶
type ProtocolConfig struct {
Scheme string `yaml:"scheme" json:"scheme"`
Description string `yaml:"description,omitempty" json:"description,omitempty"`
}
ProtocolConfig defines the structure for a custom protocol in wails.json/wails.yaml
type ReleaseNotesOptions ¶
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 RuntimeOptions ¶
type RuntimeOptions struct {
Directory string `name:"d" description:"Directory to generate runtime file in" default:"."`
}
type SetupOptions ¶
type SetupOptions struct{}
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 TemplateEnrichment ¶
type TemplateEnrichment struct {
Cls string `description:"A helper for using close template tags safely }}" default:"}}"`
Opn string `description:"A helper for using open template tags safely {{" default:"{{"`
// BackgroundModes feeds the iOS Info.plist template's UIBackgroundModes block.
// It's populated by the iOS Xcode generator from ios.backgroundModes in
// build/config.yml; the generic build-assets path leaves it empty (like
// MinIOSVersion there, it doesn't read the ios: section), so no
// UIBackgroundModes key is emitted unless configured.
BackgroundModes []string `yaml:"-"`
}
type ToolCapabilitiesOptions ¶
type ToolCapabilitiesOptions struct{}
type ToolCheckPortOptions ¶
type ToolVersionOptions ¶
type ToolVersionOptions struct {
Version string `name:"v" description:"Current version to bump"`
Major bool `name:"major" description:"Bump major version"`
Minor bool `name:"minor" description:"Bump minor version"`
Patch bool `name:"patch" description:"Bump patch version"`
Prerelease bool `name:"prerelease" description:"Bump prerelease version (e.g., alpha.5 to alpha.6)"`
}
type UpdateBuildAssetsOptions ¶
type UpdateBuildAssetsOptions struct {
Dir string `description:"The directory to generate the files into" default:"build"`
Name string `description:"The name of the project"`
BinaryName 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:"© 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"`
CFBundleIconName string `description:"The macOS icon name (for Assets.car icon bundles)"`
MinIOSVersion string `description:"Minimum iOS version for the generated Info.plist" default:"15.0"`
Config string `description:"The path to the config file"`
Silent bool `description:"Suppress output to console"`
}
UpdateBuildAssetsOptions defines the options for updating build assets.
type UpdateCLIOptions ¶
type UpdateCLIOptions struct {
NoColour bool `name:"n" description:"Disable colour output"`
PreRelease bool `name:"pre" description:"Update to the latest pre-release (eg beta)"`
Version string `name:"version" description:"Update to a specific version (eg v3.0.0)"`
Latest bool `name:"latest" description:"Install the latest stable release"`
}
type UpdateConfig ¶
type UpdateConfig struct {
TemplateEnrichment
UpdateBuildAssetsOptions
FileAssociations []FileAssociation `yaml:"fileAssociations"`
Protocols []ProtocolConfig `yaml:"protocols,omitempty"`
}
UpdateConfig defines the configuration for updating build assets.
type UpdaterGenKeyOptions ¶
type UpdaterGenKeyOptions struct {
Out string `` /* 130-byte string literal not displayed */
Force bool `name:"force" description:"Overwrite existing key files"`
}
UpdaterGenKeyOptions are the flags for `wails3 updater genkey`.
type UpdaterManifestOptions ¶
type UpdaterManifestOptions struct {
Version string `name:"version" description:"Release version (semver). Required"`
Channel string `name:"channel" description:"Release channel, e.g. stable or beta"`
Name string `name:"name" description:"Human-readable release title"`
Notes string `name:"notes" description:"Release notes (Markdown)"`
NotesFile string `name:"notes-file" description:"Read release notes from a Markdown file"`
Key string `name:"key" description:"Private key path. When set, every artifact is signed (ed25519ph over its sha512 digest)"`
URLPrefix string `` /* 133-byte string literal not displayed */
Output string `name:"output" description:"Where to write the manifest, or - for stdout" default:"manifest.json"`
}
UpdaterManifestOptions are the flags for `wails3 updater manifest`.
type UpdaterSignOptions ¶
type UpdaterSignOptions struct {
Key string `name:"key" description:"Path to the private key generated by 'wails3 updater genkey'"`
}
UpdaterSignOptions are the flags for `wails3 updater sign`.
type UpdaterVerifyOptions ¶
type UpdaterVerifyOptions struct {
Manifest string `name:"manifest" description:"Path to the manifest to verify" default:"manifest.json"`
PublicKey string `name:"publickey" description:"Public key: path to the .pub file, or a base64 string"`
Dir string `name:"dir" description:"Directory containing the artifact files. Defaults to the manifest's directory"`
}
UpdaterVerifyOptions are the flags for `wails3 updater verify`.
type VersionOptions ¶
type VersionOptions struct{}
type WailsConfig ¶
type WailsConfig struct {
Info struct {
CompanyName string `yaml:"companyName"`
ProductName string `yaml:"productName"`
ProductIdentifier string `yaml:"productIdentifier"`
Description string `yaml:"description"`
Copyright string `yaml:"copyright"`
Comments string `yaml:"comments"`
Version string `yaml:"version"`
CFBundleIconName string `yaml:"cfBundleIconName,omitempty"`
} `yaml:"info"`
FileAssociations []FileAssociation `yaml:"fileAssociations,omitempty"`
Protocols []ProtocolConfig `yaml:"protocols,omitempty"`
}
WailsConfig defines the structure for a Wails configuration.
type WatcherOptions ¶
type WatcherOptions struct {
Config string `description:"The config file including path" default:"."`
}
Source Files
¶
- android_overlay_gen.go
- appimage.go
- bindings.go
- bindings_sync.go
- build-assets.go
- capabilities.go
- constants.go
- dev.go
- doctor.go
- doctor_ng.go
- dot_desktop.go
- entitlements_setup.go
- generate_template.go
- generate_webview2.go
- icons.go
- init.go
- ios_overlay_gen.go
- ios_xcode_gen.go
- mcp.go
- msix.go
- releasenotes.go
- runtime.go
- service.go
- setup.go
- sign.go
- signing_setup.go
- syso.go
- task.go
- task_wrapper.go
- tool_buildinfo.go
- tool_checkport.go
- tool_cp.go
- tool_docker_mounts.go
- tool_lipo.go
- tool_package.go
- tool_version.go
- update_cli.go
- updater_tool.go
- version.go
- wake_report.go
- watcher.go
Directories
¶
| Path | Synopsis |
|---|---|
|
build_assets
|
|
|
android/scripts/deps
command
|
|
|
ios
command
|
|
|
ios/scripts/deps
command
|
|