Skip to main content

index

A platform toolkit based on iced for creating applets and applications for the COSMIC™ desktop.

Contribute compute — no code needed​

Donate time with your AI CLI.

Your machine runs one task at a time using your signed-in AI coding CLI. The relay alternates between eligible School (OS) and Reef (apps) hives after each task. If one hive has no work, the other can continue.

The guide covers prerequisites, verified just setup, credentials, provider costs, and how to stop with Ctrl+C. Your subscription quota or API charges apply. Never post account credentials or API keys in issues or pull requests.

Documentation​

Templates​

Dependencies​

While libcosmic is written entirely in Rust, some of its dependencies may require shared system library headers to be installed. On Pop!_OS, the following dependencies are all that's necessary to compile a typical COSMIC project:

sudo apt install cargo cmake just libexpat1-dev libfontconfig-dev libfreetype-dev libxkbcommon-dev pkgconf

Made-for-COSMIC Flatpak IDs​

To identify a project as a COSMIC Application, add <id>com.system76.CosmicApplication</id> to the provides section of the project's metainfo.

<provides>
<id>com.system76.CosmicApplication</id>
</provides>

For COSMIC Applets, use com.system76.CosmicApplet.

<provides>
<id>com.system76.CosmicApplet</id>
</provides>

Examples​

Some examples are included in the examples directory to to kickstart your COSMIC adventure. To run them, you need to clone the repository with the following commands:

git clone --recurse-submodules https://github.com/pop-os/libcosmic
cd libcosmic

If you have already cloned the repository, run these to sync with the latest updates:

git fetch origin
git checkout master
git reset --hard origin/master

The examples may then be run by their cargo project names, such as just run application.

Cargo Features​

Available cargo features to choose from:

  • a11y: Experimental accessibility support.
  • animated-image: Enables animated images from the image crate.
  • debug: Enables addtional debugging features.
  • smol: Uses smol as the preferred async runtime.
    • Conflicts with tokio
  • tokio: Uses tokio as the preferred async runtime.
    • If unset, the default executor defined by iced will be used.
    • Conflicts with smol
  • wayland: Wayland-compatible client windows.
    • Conflicts with winit
  • winit: Cross-platform and X11 client window support
    • Conflicts with wayland
  • wgpu: GPU accelerated rendering with WGPU.
    • By default, softbuffer is used for software rendering.
  • xdg-portal: Enables XDG portal dialog integrations.

Project Showcase​

Licence​

Licensed under the Mozilla Public License 2.0.

Contact​