Commands¶
From the root directory of your project you have the following sub-commands available:
clickable¶
Runs the default sub-commands specified in the “default” config. A dirty build
without cleaning the build dir can be achieved by running
clickable --dirty.
clickable desktop¶
Compile and run the app on the desktop.
Note: ArchLinux user might need to run xhost +local:clickable before using
desktop mode.
Run clickable desktop --verbose to show the executed docker command.
Run clickable desktop --dark-mode to set the dark mode preference.
Run clickable desktop --lang <language code> to test using a different language.
clickable desktop --nvidia¶
clickable checks automatically if nvidia-drivers are installed and turns on nvidia
mode. If prime-select is installed, it is queried to check whether the nvidia-driver
is actually in use.
The --nvidia flag lets you manually enforce nvidia mode. The --no-nvidia
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
- nvidia-modprobe
- nvidia-docker
On Ubuntu, install these requirements using apt install nvidia-modprobe nvidia-docker.
docker >= 19.03 system requirements
- nvidia-container-toolkit
On Ubuntu, install these requirements using apt install nvidia-container-toolkit.
Run clickable with the --verbose flag to see the executed command for your system.
clickable ide <custom_command>¶
Will run custom_command inside ide container wrapper.
e.g. Launch qtcreator: clickable ide qtcreator.
clickable create¶
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.
clickable shell¶
Opens a shell on the device via ssh. This is similar to the phablet-shell command.
clickable clean-libs¶
Cleans out all library build dirs.
clickable build-libs¶
Builds the dependency libraries specified in the clickable.json.
clickable clean¶
Cleans out the build dir.
clickable build¶
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@ to have Clickable replace
it with the appropriate value.
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 --output.
clickable clean-build¶
Cleans out the build dir before building the project as outlined in the
clickable build docs.
clickable review¶
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.
clickable test¶
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 clickable.json.
clickable install¶
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
clickable launch¶
Launches the app on a device.
clickable launch <app name>
Launches the specified app on a device.
clickable logs¶
Follow the apps log file on the device.
clickable log¶
Dumps the apps log file on the device.
clickable publish¶
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 not command is specified.
clickable update¶
Update the docker container for use with clickable.
clickable no-lock¶
Turns off the device’s display timeout.
clickable writable-image¶
Make your Ubuntu Touch device’s rootfs writable. This replaces to old
phablet-config writable-image command.
clickable devices¶
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 -s
argument.
clickable <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.