Installation Guide

Installing UCS itself

Before using ucs to install components, you first need to install ucs itself!

To install ucs, we need to add a PPA

sudo add-apt-repository ppa:ubuntu-touch-community-dev/ppa
sudo apt-get update
sudo apt-get install ucs

Finding Components

Use the search command to search for available components by name or description.:

$ ucs search state
Matching curated components:
                      EmptyState
Matching community components:
                    (no matches)
$ ucs search podcast
Matching curated components:
                    (no matches)
Matching community components:
           sil/GenericPodcastApp  A component which manages a podcast RSS feed, with playback and display of episodes

You can list all components in the store, both curated and community components, with ucs search.

Installing Components

You can install components individually using the install command,

ucs install EmptyState
ucs install PageWithBottomEdge
ucs install sil/GenericPodcastApp

Note

Remember to run the ucs command from inside your application’s component folder!

You can then use the components by importing it in your qml files by,

import ubuntu_component_store.Curated.EmptyState 1.0
import ubuntu_component_store.Curated.PageWithBottomEdge 1.0
import ubuntu_component_store.sil.GenericPodcastApp 1.0

Note

Community components are named as developer/ComponentName. Curated components are installed with just a ComponentName (like ucs install EmptyState), but when importing them in QML you must call them ubuntu_component_store.Curated.EmptyState as above.

Updating Components

You can also update the UCS components using the ucs script. It will automatically fetch the latest upstream code.

ucs update EmptyState

Note

Remember to run the ucs command from inside your application’s component folder!

You can see the full ucs script help using the help argument,

ucs help