commands

Documentation

Index

• Constants
• Variables
• func InitLibraryManager(pm *packagemanager.PackageManager) *librariesmanager.LibrariesManager
• func InitPackageManager() *packagemanager.PackageManager
• func InitPackageManagerWithoutBundles() *packagemanager.PackageManager
• func InitSketch(sketchPath *paths.Path) (*sk.Sketch, error)
• func UpdateLibrariesIndex(lm *librariesmanager.LibrariesManager)

Constants

const (
	ErrGeneric // 1 is the reserved "catchall" code in Unix

	ErrNoConfigFile
	ErrBadCall
	ErrNetwork
	// ErrCoreConfig represents an error in the cli core config, for example some basic
	// files shipped with the installation are missing, or cannot create or get basic
	// directories vital for the CLI to work.
	ErrCoreConfig
	ErrBadArgument
)

Error codes to be used for os.Exit().

Variables

var AppName = filepath.Base(os.Args[0])

AppName is the command line name of the Arduino CLI executable

var Config *configs.Configuration

var ErrLogrus = logrus.New()

ErrLogrus represents the logrus instance, which has the role to log all non info messages.

var GlobalFlags struct {
	Debug  bool   // If true, dump debug output to stderr.
	Format string // The Output format (e.g. text, json).
}

GlobalFlags represents flags available in all the program.

var Version = "0.3.3-alpha.preview"

Version is the current CLI version

Functions

func InitLibraryManager

func InitLibraryManager(pm *packagemanager.PackageManager) *librariesmanager.LibrariesManager

InitLibraryManager initializes the LibraryManager using the underlying packagemanager

func InitPackageManager

func InitPackageManager() *packagemanager.PackageManager

InitPackageManager initializes the PackageManager TODO: for the daemon mode, this might be called at startup, but for now only commands needing the PM will call it

func InitPackageManagerWithoutBundles

func InitPackageManagerWithoutBundles() *packagemanager.PackageManager

InitPackageManagerWithoutBundles initializes the PackageManager but ignores bundles and user installed cores

func InitSketch

func InitSketch(sketchPath *paths.Path) (*sk.Sketch, error)

func UpdateLibrariesIndex

func UpdateLibrariesIndex(lm *librariesmanager.LibrariesManager)

UpdateLibrariesIndex updates the library_index.json