commands

type AndroidDevicesOptions struct{}

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"`
}

type AndroidRunOptions struct {
	Profile      string `name:"profile" description:"Build configuration profile (or pass it as the first argument)"`
	Device       string `name:"device" description:"Connected adb device serial"`
	Emulator     string `name:"emulator" description:"Android Virtual Device name to start or reuse"`
	APK          string `name:"apk" description:"Install an existing APK instead of building one"`
	NoLaunch     bool   `name:"no-launch" description:"Install the APK without launching the app"`
	Logs         bool   `name:"logs" description:"Stream application logs and monitor the target until the app exits or Ctrl+C"`
	StopEmulator bool   `name:"stop-emulator" description:"Stop the selected emulator when an attached run exits"`
}

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"`
}

type BuildConfig struct {
	BuildAssetsOptions
	TemplateEnrichment
	FileAssociations []FileAssociation `yaml:"fileAssociations"`
	Protocols        []ProtocolConfig  `yaml:"protocols,omitempty"`
}

type BuildInfoOptions struct{}

type Capabilities struct {
	Platform string             `json:"platform"`
	Arch     string             `json:"arch"`
	Linux    *LinuxCapabilities `json:"linux,omitempty"`
}

type ConfigCheckOptions struct {
	Profile string `name:"profile" description:"Validate only this named profile"`
}

type CpOptions struct{}

type DevOptions struct {
	AppArgs []string `name:"appargs" description:"Application arguments as one shell-quoted string; prefer -- followed by arguments"`

	Verbose     bool   `name:"verbose" description:"Stream build commands and output during development"`
	Quiet       bool   `name:"quiet" description:"Only show development failures"`
	Host        string `name:"host" description:"Frontend bind address (use this Mac’s LAN IP for a physical iOS device)"`
	Device      string `name:"device" description:"iOS device/simulator identifier or Android adb serial"`
	Emulator    string `name:"emulator" description:"Android Virtual Device to start or reuse"`
	Destination string `name:"destination" description:"iOS destination: simulator (default) or device"`
	flags.Common

	Config   string `description:"The config file including path" default:"./build/config.yml"`
	VitePort int    `name:"port" description:"Specify the vite dev server port"`
	Secure   bool   `name:"s" description:"Enable HTTPS"`
	Tags     string `name:"tags" description:"Additional development build tags to pass to the Go compiler (comma-separated)"`
	Profile  string `name:"profile" description:"Manifest profile to apply"`
	Target   string `name:"target" description:"Target platform and architecture"`
	Plan     bool   `name:"plan" description:"Print the finite development startup plan without starting a session"`
	// contains filtered or unexported fields
}

type DockerMountsOptions struct{}

type DoctorNgOptions struct {
	NonInteractive bool `name:"n" description:"Run in non-interactive mode (no TUI)"`
}

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 EjectOptions struct {
	Force bool `name:"force" description:"Replace an existing wails.ejected.yaml atomically"`
}

type Entitlement struct {
	Key         string
	Name        string
	Description string
	Category    string
}

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"`
}

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 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 GenerateWebView2Options struct {
	Directory string `name:"dir" json:"directory"`
}

type HasCCOptions struct{}

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)"`
}

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"`
}

type IOSXcodeGenOptions struct {
	Icon   string `description:"Path to the application icon PNG"`
	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"`
}

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, 1-256 pixels)" 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 struct {
	GTK4Available        bool   `json:"gtk4_available"`
	GTK3Available        bool   `json:"gtk3_available"`
	WebKitGTK6Available  bool   `json:"webkitgtk_6_available"`
	WebKit2GTK4Available bool   `json:"webkit2gtk_4_1_available"`
	Recommended          string `json:"recommended"`
}

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"`
}

type MSIXOptions struct {
	WailsConfig
	// 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"`
	AppxManifest          string `json:"appxManifest,omitempty"`
	IconPath              string `json:"iconPath,omitempty"`
	UseMsixPackagingTool  bool   `json:"useMsixPackagingTool"`
	UseMakeAppx           bool   `json:"useMakeAppx"`
}

type MigrateOptions struct {
	DryRun   bool   `name:"dry-run" description:"Analyse without writing project files"`
	JSON     bool   `name:"json" description:"Print the machine-readable report"`
	Activate bool   `name:"activate" description:"Validate a reviewed migration draft and atomically activate it"`
	Output   string `name:"output" description:"Write or activate an inactive proposal at this project-relative path"`
}

type MigrationDiagnostic = migration.Diagnostic

type MigrationReport = migration.Report

type PrepareMacOSOutputOptions struct {
	Dir string `name:"dir" description:"Project build output directory" default:"bin"`
}

type ProtocolConfig struct {
	Scheme      string `yaml:"scheme"                json:"scheme"`
	Description string `yaml:"description,omitempty" json:"description,omitempty"`
}

type ReleaseNotesOptions struct {
	Version  string `name:"v" description:"The version to show release notes for"`
	NoColour bool   `name:"n" description:"Disable colour output"`
}

type RunOptions struct {
	SkipBuild   bool     `name:"skip-build" description:"Run existing desktop binaries from the YAML output directory without building"`
	AppArgs     []string `name:"appargs" description:"Application arguments as one shell-quoted string; prefer -- followed by arguments"`
	Device      string   `name:"device" description:"Android adb serial or iOS device/simulator identifier"`
	Emulator    string   `name:"emulator" description:"Android Virtual Device to start or reuse"`
	Destination string   `name:"destination" description:"iOS destination: simulator (default) or device"`

	Tags   string `name:"tags" description:"Additional comma-separated Go build tags"`
	Target string `name:"target" description:"One platform/architecture to run (defaults to the host)"`
	Plan   bool   `name:"plan" description:"Show resolved build and launch settings without executing"`
}

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 struct {
	Directory string `name:"d" description:"Directory to generate runtime file in" default:"."`
}

type SetupOptions struct{}

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"`
}

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 struct{}

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 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 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"`
}

type UpdateCLIOptions struct {
	NoColour   bool   `name:"n" description:"Disable colour output"`
	PreRelease bool   `name:"pre" description:"Update to the newest build of any kind, including nightlies"`
	Nightly    bool   `name:"nightly" description:"Update to the newest nightly pre-release"`
	Version    string `name:"version" description:"Update to a specific version (eg v3.0.0)"`
	Latest     bool   `name:"latest" description:"Install the newest release (weekly or hotfix, no nightlies)"`
}

type UpdateConfig struct {
	TemplateEnrichment
	UpdateBuildAssetsOptions
	FileAssociations []FileAssociation `yaml:"fileAssociations"`
	Protocols        []ProtocolConfig  `yaml:"protocols,omitempty"`
}

type UpdaterGenKeyOptions struct {
	Out   string `` /* 130-byte string literal not displayed */
	Force bool   `name:"force" description:"Overwrite existing key files"`
}

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"`
}

type UpdaterSignOptions struct {
	Key string `name:"key" description:"Path to the private key generated by 'wails3 updater genkey'"`
}

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"`
}

type VersionOptions struct{}

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"`
}

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