Documentation
¶
Index ¶
- Variables
- func BindFlags(cmd *cobra.Command, settings *viper.Viper)
- func BuiltinToolsDirectories(settings *viper.Viper) paths.PathList
- func DataDir(settings *viper.Viper) *paths.Path
- func DownloadsDir(settings *viper.Viper) *paths.Path
- func FindConfigFileInArgs(args []string) string
- func GetDefaultBuiltinLibrariesDir() string
- func HardwareDirectories(settings *viper.Viper) paths.PathList
- func IDEBuiltinLibrariesDir(settings *viper.Viper) *paths.Path
- func Init(configFile string) *viper.Viper
- func LibrariesDir(settings *viper.Viper) *paths.Path
- func NetworkProxy(settings *viper.Viper) (*url.URL, error)
- func PackagesDir(settings *viper.Viper) *paths.Path
- func ProfilesCacheDir(settings *viper.Viper) *paths.Path
- func SetDefaults(settings *viper.Viper)
- func UserAgent(settings *viper.Viper) string
Constants ¶
This section is empty.
Variables ¶
var HasConsole = isatty.IsTerminal(os.Stdout.Fd()) || isatty.IsCygwinTerminal(os.Stdout.Fd())
HasConsole is set to true if the CLI outputs to a terminal/console
var IsInteractive = isatty.IsTerminal(os.Stdin.Fd()) || isatty.IsCygwinTerminal(os.Stdin.Fd())
IsInteractive is set to true if the CLI is interactive (it can receive inputs from terminal/console)
var Settings *viper.Viper
Settings is a global instance of viper holding configurations for the CLI and the gRPC consumers
Functions ¶
func BindFlags ¶
BindFlags creates all the flags binding between the cobra Command and the instance of viper
func BuiltinToolsDirectories ¶
BuiltinToolsDirectories returns all paths that may contains bundled-tools.
func DownloadsDir ¶
DownloadsDir returns the full path to the download cache directory
func FindConfigFileInArgs ¶
FindConfigFileInArgs returns the config file path using the argument '--config-file' (if specified) or looking in the current working dir
func GetDefaultBuiltinLibrariesDir ¶
func GetDefaultBuiltinLibrariesDir() string
GetDefaultBuiltinLibrariesDir returns the full path to the default builtin libraries dir
func HardwareDirectories ¶
HardwareDirectories returns all paths that may contains hardware packages.
func IDEBuiltinLibrariesDir ¶
IDEBuiltinLibrariesDir returns the IDE-bundled libraries path. Usually this directory is present in the Arduino IDE.
func Init ¶
Init initialize defaults and read the configuration file. Please note the logging system hasn't been configured yet, so logging shouldn't be used here.
func LibrariesDir ¶
LibrariesDir returns the full path to the user directory containing custom libraries
func NetworkProxy ¶
NetworkProxy returns the proxy configuration (mainly used by HTTP clients)
func PackagesDir ¶
PackagesDir returns the full path to the packages folder
func ProfilesCacheDir ¶
ProfilesCacheDir returns the full path to the profiles cache directory (it contains all the platforms and libraries used to compile a sketch using profiles)
func SetDefaults ¶
SetDefaults sets the default values for certain keys
Types ¶
This section is empty.
Source Files