flags

Documentation

Overview

Copyright (c) 2014-2019 Cesanta Software Limited All rights reserved

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• func Platform() string
• func TLSConfigFromFlags() (*tls.Config, error)

Variables

var (
	Port = flag.String("port", "auto", "Serial port where the device is connected. "+
		"If set to 'auto', ports on the system will be enumerated and the first will be used.")
	BaudRate    = flag.Int("baud-rate", 115200, "Serial port speed")
	Board       = flag.String("board", "", "Board name.")
	BuildInfo   = flag.String("build-info", "", "")
	Checksums   = flag.StringSlice("checksums", []string{"sha1"}, "")
	Description = flag.String("description", "", "")
	Input       = flag.StringP("input", "i", "", "")
	Manifest    = flag.String("manifest", "", "")
	Name        = flag.String("name", "", "")
	Output      = flag.StringP("output", "o", "", "")

	SrcDir   = flag.String("src-dir", "", "")
	Compress = flag.Bool("compress", false, "")

	Credentials = flag.String("credentials", "", "Credentials to use when accessing protected resources such as Git repos and their assets. "+
		"Can be comma-separated list of host:token entries or refer to a file @/path/to/credentials (one entry per line).")
	GHToken = flag.String("gh-token", "", "Deprecated, please use --credentials") // Deprecated: 2020-08-06

	ChunkSize      = flag.Int("chunk-size", 512, "Chunk size for operations")
	FsOpAttempts   = flag.Int("fs-op-attempts", 3, "Chunk size for operations")
	PID            = flag.String("pid", "mos", "")
	UID            = flag.String("uid", "", "")
	CertFile       = flag.String("cert-file", "", "Certificate file name")
	KeyFile        = flag.String("key-file", "", "Key file name")
	CAFile         = flag.String("ca-cert-file", "", "CA certificate file name")
	CAKeyFile      = flag.String("ca-key-file", "", "CA key file name (for cert signing)")
	RPCUARTNoDelay = flag.Bool("rpc-uart-no-delay", false, "Do not introduce delay into UART over RPC")
	Timeout        = flag.Duration("timeout", 20*time.Second, "Timeout for the device connection and call operation")
	Reconnect      = flag.Bool("reconnect", false, "Enable reconnection")
	HWFC           = flag.Bool("hw-flow-control", false, "Enable hardware flow control (CTS/RTS)")

	LicenseServer    = flag.String("license-server", "https://license.mongoose-os.com", "License server address")
	LicenseServerKey = flag.String("license-server-key", "", "License server key")

	InvertedControlLines = flag.Bool("inverted-control-lines", false, "DTR and RTS control lines use inverted polarity")
	SetControlLines      = flag.Bool("set-control-lines", true, "Set RTS and DTR explicitly when in console/RPC mode")

	AzureConnectionString = flag.String("azure-connection-string", "", "Azure connection string")

	GCPProject        = flag.String("gcp-project", "", "Google IoT project ID")
	GCPRegion         = flag.String("gcp-region", "", "Google IoT region")
	GCPRegistry       = flag.String("gcp-registry", "", "Google IoT device registry")
	GCPCertFile       = flag.String("gcp-cert-file", "", "Certificate/public key file")
	GCPKeyFile        = flag.String("gcp-key-file", "", "Private key file")
	GCPRPCCreateTopic = flag.Bool("gcp-rpc-create-topic", false, "Create RPC topic plumbing if needed")

	Level    = flag.Int("level", -1, "Config level; default - runtime")
	NoReboot = flag.Bool("no-reboot", false, "Save config but don't reboot the device.")
	NoSave   = flag.Bool("no-save", false, "Don't save config and don't reboot the device")
	TryOnce  = flag.Bool("try-once", false, "When saving the config, do it in such a way that it's only applied on the next boot")

	Format       = flag.String("format", "", "Config format, hex or json")
	WriteKey     = flag.String("write-key", "", "Write key file")
	CSRTemplate  = flag.String("csr-template", "", "CSR template to use")
	CertTemplate = flag.String("cert-template", "", "cert template to use")
	CertDays     = flag.Int("cert-days", 0, "new cert validity, days")
	Subject      = flag.String("subject", "", "Subject for CSR or certificate")

	GDBServerCmd = flag.String("gdb-server-cmd", "/usr/local/bin/serve_core.py", "")

	KeepTempFiles = flag.Bool("keep-temp-files", false, "keep temp files after the build is done (by default they are in ~/.mos/tmp)")
	KeepFS        = flag.Bool("keep-fs", false, "When flashing, skip the filesystem parts")

	// create-fw-bundle flags.
	Attr      = flag.StringArray("attr", nil, "manifest attribute, can be used multiple times")
	ExtraAttr = flag.StringArray("extra-attr", nil, "manifest extra attribute info to be added to ZIP")
	SignKeys  = flag.StringArray("sign-key", nil, "Signing private key file name. Can be used multiple times for multipl signatures.")

	StateFile = flag.String("state-file", "~/.mos/state.json", "Where to store internal mos state")
	AuthFile  = flag.String("auth-file", "~/.mos/auth.json", "Where to store license server auth key")

	// Build flags.
	BuildParams = flag.String("build-params", "", "build params file")
	TempDir     = flag.String("temp-dir", "~/.mos/tmp", "Directory to store temporary files")
	DepsDir     = flag.String("deps-dir", "", "Directory to fetch libs, modules into")
	LibsDir     = flag.StringSlice("libs-dir", []string{}, "Directory to find libs in. Can be used multiple times.")
	ModulesDir  = flag.String("modules-dir", "", "Directory to store modules into")

	Local              = flag.Bool("local", false, "Local build.")
	Clean              = flag.Bool("clean", false, "Perform a clean build, wipe the previous build state")
	MosRepo            = flag.String("repo", "", "Path to the mongoose-os repository; if omitted, the mongoose-os repository will be cloned as ./mongoose-os")
	Verbose            = flag.Bool("verbose", false, "Verbose output")
	Modules            = flag.StringArray("module", []string{}, "location of the module from mos.yaml, in the format: \"module_name:/path/to/location\". Can be used multiple times.")
	Libs               = flag.StringArray("lib", []string{}, "location of the lib from mos.yaml, in the format: \"lib_name:/path/to/location\". Can be used multiple times.")
	NoLibsUpdate       = flag.Bool("no-libs-update", false, "if true, never try to pull existing libs (treat existing default locations as if they were given in --lib)")
	LibsUpdateInterval = flag.Duration("libs-update-interval", time.Hour*1, "how often to update already fetched libs")
	BuildVars          = flag.StringSlice("build-var", []string{}, `Build variable in the format "NAME=VALUE". Can be used multiple times.`)
	CDefs              = flag.StringSlice("cdef", []string{}, `C/C++ define in the format "NAME=VALUE". Can be used multiple times.`)
	BuildDryRun        = flag.Bool("build-dry-run", false, "do not actually run the build, only prepare")
	BuildTarget        = flag.String("build-target", moscommon.BuildTargetDefault, "target to build with make")
	NoPlatformCheck    = flag.Bool("no-platform-check", false, "override platform support check")
	CFlagsExtra        = flag.StringArray("cflags-extra", []string{}, "extra C flag, appended to the \"cflags\" in the manifest. Can be used multiple times.")
	CXXFlagsExtra      = flag.StringArray("cxxflags-extra", []string{}, "extra C++ flag, appended to the \"cxxflags\" in the manifest. Can be used multiple times.")
	LibsExtra          = flag.StringArray("lib-extra", []string{}, "Extra libs to add to the app being built. Value should be a YAML string. Can be used multiple times.")
	SaveBuildStat      = flag.Bool("save-build-stat", true, "save build statistics")
	PreferPrebuiltLibs = flag.Bool("prefer-prebuilt-libs", false, "if both sources and prebuilt binary of a lib exists, use the binary")

	DepsVersions       = flag.String("deps-versions", "", "If specified, this file will be consulted for all libs and modules versions")
	StrictDepsVersions = flag.Bool("strict-deps-versions", true, "If set, then --deps-versions will be in strict mode: missing deps will be disallowed")

	// Local build flags.
	BuildDockerExtra = flag.StringArray(
		"build-docker-extra", []string{},
		"extra docker flags, added before image name. Can be used multiple times: "+
			"e.g. --build-docker-extra -v --build-docker-extra /foo:/bar.",
	)
	BuildDockerNoMounts = flag.Bool(
		"build-docker-no-mounts", false,
		"if set, then mos will not add bind mounts to the docker invocation. "+
			"For build to work, volumes will need to be provided externally via --build-docker-extra, "+
			"e.g. --build-docker-extra=--volumes-from=outer",
	)
	BuildImage       = flag.String("build-image", "", "Override the Docker image used for build.")
	BuildParalellism = flag.Int("build-parallelism", 0, "build parallelism. default is to use number of CPUs.")

	// Flashing flags
	NoVerify = flag.Bool("no-verify", false, "Do not verify flashed image")
)

Functions

func Platform

func Platform() string

func TLSConfigFromFlags

func TLSConfigFromFlags() (*tls.Config, error)