libcosmic-template

README

About

Generates the boilerplate for libcosmic applications on the COSMIC DE. Currently only applets are supported. Includes the justfile for installing the applet and icons aswell as translation support.

Install

Go(>=1.22) is required to build. Prebuilt binaries are available in the releases section.

go install github.com/leb-kuchen/libcosmic-template@latest

Versioning

The current API is not stable and breaking changes will be made, but only on a minor and never on a patch.

Usage

-c, --config               Generate cosmic-config (default true)
    --icon string          Icon name (default "display-symbolic")
    --icon-files strings   path to icon files
    --id string            App ID (default "com.system76.CosmicAppletExample")
-i, --interactive          Activate interactive mode
-n, --name string          App name (default "cosmic-applet-example")
    --no-confirm           Do not ask for confirmation
    --no-example           Do not generate example row
-V, --version              Show the latest version

Getting started

libcosmic-template
cd cosmic-applet-example
cargo b -r
sudo just install

The example applet should now appear in the panel settings.

Example

libcosmic-template --id=org.example1.com --name=example-example-applet1 --icon="zoom-original-symbolic.svg" --icon-files= "zoom-original-symbolic.svg"