You load the CLI by using the
--cli command-line flag to the
You can also provide the path to a sketch to work on.
$ uecide --cli Documents/UECIDE/Blink Loading assets...done Loaded sketch: Blink Board: arduino-uno (Arduino Uno) Core: arduino (Arduino 1.8.2) Compiler: avr-gcc (GCC 4.9.2 for AVR) Programmer: Avrdude for Arduino boards Port: /dev/ttyACM0 Blink> _
As you can see the currently selected board, etc, is shown once loaded. You can get this information at any time by typing
Blink> info Board: arduino-uno (Arduino Uno) Core: arduino (Arduino 1.8.2) Compiler: avr-gcc (GCC 4.9.2 for AVR) Programmer: Avrdude for Arduino boards Port: /dev/ttyACM0 Blink> _
The CLI has tab completion. That means you can press the
TAB key at any time to complete the command or parameter you are typing. If you have no command started or no option started it will show you all the available commands or parameters at the current moment in time.
For example, pressing
TAB at the command prompt with nothing else entered gives you a list of all posisble commands:
Blink> _ ls core help load port board rescan compile compiler pkg-update pkg-install vi edit info make quit purge upload verbose pkg-remove programmer
TAB a second time will allow you to interactively navigate to the command or parameter you want to use. This is especially useful when there are a lot of similarly named parameters.
ls command lists the files in your sketch. Note: this does not list all the files in the sketch folder, only the ones that directly pertain to your sketch (INO, PDE, cpp, h, etc).
load will allow you to load a new sketch.
compile both compile the sketch with the currently selected board settings.
upload compiles and programs the sketch into your target board.
The board can be selected with the
board command. If needed the compiler and core, as well as the programmer, can be selected with the
programmer commands. Use tab completion to help find the right name for the item you want.
purge will clean the compilation files out of the cache and give you a completely fresh build.
edit will let you edit a file using your system default editor.
pkg-remove will allow you to update the list of packages, and install or remove plugins.