The behavior of Clickable is controlled via commands, each with their own set of available parameters.
clickable <command> [param ...]
This documentation only lists some selected commands and parameters. Run
clickable --help to see the list of all available commands and
clickable <command> --help to get a command-specific help message listing its
Project-specific commands like
install can be executed from the projec
root or any of its sub-directories, given there is a project config in the project root.
Running Clickable without a command is a shortcut to the default
chain command (see
below). This special case allows a few universal parameters like
Chains multiple commands that can be specified. The default chain can be configured via the
default field. If not configured, the default is
build install launch.
A clean build in a chain can be enforced by running
clickable chain --clean.
Compiles and runs the app on the desktop. Accepts the same arguments as the
plus some desktop mode specific ones.
Note: ArchLinux user might need to run
xhost +local:clickable before using
clickable desktop --dark-mode to set the dark mode preference.
clickable desktop --lang <language code>_<country code> (for example, fr_FR)
to test using a different language.
clickable desktop --gdb to start the app via GDB.
clickable desktop --qmllive on a QML only app enable QML live update when QML files are
The env var
CLICKABLE_DESKTOP_MODE is set in desktop mode.
Will run an IDE inside the Clickable docker container, QtCreator by default.
Will open a root bash inside a Clickable CI container that can be used to debug a CI job.
Opens a bash inside the Clickable docker container to analyze the build environment. This is only meant to inspect the container. Changes do not persist.
clickable run -- <some command> runs an arbitrary command in the Clickable container.
Generate a new app from a list of app template options.
Opens a SSH shell on a connected device either via SSH or ADB.
Cleans out the app build dir. Can be applied to libraries by appending
Builds the project using the specified builder, build dir, and build commands. Then it takes the built files and compiles them into a click package (you can find it in the build dir). Finally runs a review.
Set the manifest architecture field to
@CLICK_ARCH@ and the framework field
@CLICK_FRAMEWORK@ to have Clickable replace them with the appropriate values.
Specify where to put the compiled click by
Builds libraries specified in the project config using the
Takes the built click package and runs click-review against it. This allows you to review your click without installing click-review on your computer.
The review runs automatically after a
Run your test suite with a virtual screen. By default this runs
but you can specify a custom command by setting the test
property in your project config.
Takes a built click package from the build dir and installs it on a connected device.
Launches the app on a connected device.
clickable launch <app name> launches the specified app.
Follows the app log file on a connected device.
Prints the app log file from a connected device.
Publish your click package to the OpenStore. Check the Getting started doc for more info.
clickable publish "changelog message" publishs your click app to the OpenStore
with a message prepended to the changelog.
Update the docker images used with Clickable.
Turns off the display timeout for a connected device.
Make your Ubuntu Touch device’s rootfs writable.
Lists the serial numbers and model names for attached devices using ADB. Useful when
multiple devices are attached and you need to know what to use for the
clickable script <script name> runs a custom command specified as a script in the