From the root directory of your project you have multiple sub-commands available. Run
clickable --help to list them all.
clickable <cmd> --help explains a single command in
detail. Some of the most common ones are explained below.
clickable call is equivalent to
Chains multiple commands that can be specified. The default chain can be configured via the
default field. The default chain itself defaults to
build install launch.
A clean build can be enforced by running
clickable chain --clean.
Compile and run the app on the desktop. Accepts the same arguments as the
build command plus
some desktop mode specific ones.
Note: ArchLinux user might need to run
xhost +local:clickable before using
clickable desktop --verbose to show the executed docker command.
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.
The env var
CLICKABLE_DESKTOP_MODE is set in desktop mode.
clickable desktop --nvidia¶
clickable checks automatically if nvidia-drivers are installed and turns on nvidia
prime-select is installed, it is queried to check whether the nvidia-driver
is actually in use.
--nvidia flag lets you manually enforce nvidia mode. The
flag in contrast lets you disable automatic detection.
Depending on your docker version, the docker execution will change and you need to provide additional system requirements:
docker < 19.03 system requirements
On Ubuntu, install these requirements using
apt install nvidia-modprobe nvidia-docker.
docker >= 19.03 system requirements
On Ubuntu, install these requirements using
apt install nvidia-container-toolkit.
To be able to install the nvidia-container-toolkit you have to perform the following commands (as mentioned on https://www.server-world.info/en/note?os=Ubuntu_20.04&p=nvidia&f=2):
curl -s -L https://nvidia.github.io/nvidia-docker/gpgkey | apt-key add - curl -s -L https://nvidia.github.io/nvidia-docker/ubuntu20.04/nvidia-docker.list > /etc/apt/sources.list.d/nvidia-docker.list apt update apt -y install nvidia-container-toolkit systemctl restart docker
Run clickable with the
--verbose flag to see the executed command for your system.
clickable ide <custom_command>¶
custom_command inside ide container wrapper.
e.g. Launch qtcreator:
clickable ide qtcreator.
clickable ci <custom_command>¶
custom_command inside a Clickable CI container.
Generate a new app from a list of app template options.
clickable create <app template name>
Generate a new app from an app template by name.
Opens a shell on the device via ssh. This is similar to the
Cleans out the app build dir. Can by 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).
Set the manifest architecture field to
@CLICK_ARCH@ and the framework field
@CLICK_FRAMEWORK@ to have Clickable replace them with the appropriate values.
clickable build --libs¶
Builds libraries specified in the project config.
clickable build --output=/path/to/some/diretory¶
Takes the built files and compiles them into a click package, outputting the
compiled click to the directory specified by
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.
Run your test suite in with a virtual screen. By default this runs qmltestrunner, but you can specify a custom command by setting the test property in your project config.
Takes a built click package and installs it on a device.
clickable install ./path/to/click/app.click
Installs the specified click package on the device
Launches the app on a device.
clickable launch <app name>
Launches the specified app on a device.
Follow the apps log file on the device.
Dumps the apps log file on the device.
Publish your click app to the OpenStore. Check the Getting started doc for more info.
clickable publish "changelog message"
Publish your click app to the OpenStore with a message to add to the changelog.
clickable run "some command"¶
Runs an arbitrary command in the clickable container. Changes do not persist. This is only meant to inspect the container. Opens a root bash shell if no command is specified.
Update the docker images for use with clickable.
Turns off the device’s display timeout.
Make your Ubuntu Touch device’s rootfs writable. This replaces to old
phablet-config writable-image command.
Lists the serial numbers and model names for attached devices. Useful when
multiple devices are attached and you need to know what to use for the
clickable script <custom command>¶
Runs a custom command specified in the “scripts” config
clickable <any command> --container-mode¶
Runs all builds commands on the current machine and not in a container. This is useful from running clickable from within a container.
clickable <any command> --verbose¶
Have Clickable print out debug information about whatever command(s) are being run.
clickable <any command> --ssh <ip address>¶
Run a command with a device over ssh rather than the default adb.