You can get started with using clickable with an existing Ubuntu Touch app.
You can use clickable with apps generated from the old Ubuntu Touch SDK IDE
or you can start fresh by running
To run the default set of sub-commands, simply run
clickable in the root directory
of your app’s code. Clickable will attempt to auto detect the
build template and other configuration options.
Running the default sub-commands will:
- Clean the build directory (by default the build directory is
- Compile the app
- Build the click package (can be found in the build directory)
- Install the app on your phone (By default this uses adb, see below if you want to use ssh)
- Kill the running app on the phone
- Launch the app on your phone
If you need more advanced usage options, you may specify a configuration file
in the clickable.json format with
--config. If not
specified, clickable will look for an optional configuration file called
clickable.json in the current directory.
Connecting to a device over ssh¶
By default the device is connected to via adb.
If you want to access a device over ssh you need to either specify the device
IP address or hostname on the command line (ex:
clickable logs --ssh 192.168.1.10 ) or you
can use the
CLICKABLE_SSH env var.
Multiple connected devices¶
By default clickable assumes that there is only one device connected to your
computer via adb. If you have multiple devices attached to your computer you
can specify which device to install/launch/etc on by using the flag
-s for short. You can get the serial number
GDB Debugging via Clickable is only available in desktop mode and can be started by running
clickable desktop --gdb.
Alternatively a GDB Server can be started with
clickable desktop --gdbserver <port>
(just choose any port, e.g.
3333). Check for an option to do GDB Remote Debugging in your IDE
and connect to
localhost:<port>. To connect a GDB Client run
gdb <app-binary> -ex 'target remote localhost:<port>'.