Using ClockworkInstalling Packages

Installing Packages

Install a package from the registry

A registry package is a package that is listed in the registry.yml. To install a registry package, run the following command:

clockwork install <package-name>

For a full list of packages in the registry, see Packages in the registry.

Install a package from git

clockwork install <git-url>
⚠️

Packages installed from git are not verified by Clockwork and do not meet our requirements, install at your own risk.

Listing packages

You can view all your packages by running:

clockwork packages

This will list all packages in clockwork.yaml and their versions.

Importing Packages

Clockwork works best in combination with XML Preprocessor, so you can import components into your XML code:

<WatchFace>
  <Import href="packages/my-awesome-package/component.xml"/>
</WatchFace>

In this example, we import the component from packages, where Clockwork stores all your downloaded packages, currently this is the only way to import components from packages, but that will change in the future. Visit XML Preprocessor’s documentation on <Import/> to learn more.

Updating packages

You can update all your packages to minor and patch versions by running:

clockwork update

If you want to update your packages to major, minor, and patch versions, run:

clockwork upgrade
⚠️

Major versions of packages may have breaking changes. Check the package’s documentation or changelog if you encounter issues.

Packages in the registry

Loading registry...