AppStream metadata

AppStream is a cross-distribution effort for providing metadata for software in the (Linux) ecosystem. It provides a convenient way to get information about not installed software, and is one of the building blocks for software centers.

Why should I include AppStream metadata in my AppImage?

Desktop environments, file managers, AppImage catalogs, software centers, and app stores can use metadata about the application from inside the AppImage to get a description, URLs, screenshots, and other information that describes the application. This optional metadata travels inside the AppImage.

So if you would like your application to show a nice screenshot in app centers, you should add an AppStream metainfo file to your AppImage. AppStream is a format that exists independently of AppImage and can be used in conjunction with other packaging formats as well. Many open source applications already come with AppStream metainfo files by default.

See also

More information on AppStream can be found on the pages.

Using the AppStream generator

An easy way to generate an AppStream metainfo file is to use our generator below.

General Settings

Metadata license:
Project license:
Name of the desktop file (without .desktop):
Name of the application (proper capitalization):
Summary (no dot at the end):
Description (full sentence(s) with a dot at the end):
Homepage (full URL):
Screenshot (full URL)

For more information, please refer to the AppStream documentation's Quickstart section.

Embedding the AppStream metadata

Once you have generated a suitable AppStream metainfo file, place it into usr/share/metainfo/myapp.appdata.xml in your AppDir, and generate an AppImage from it. It is generally a good idea to check AppStream metainfo files for errors using the appstreamcli and/or appstream-util command line tools. appimagetool will automatically attempt to validate the AppStream metainfo file if appstreamcli and/or appstream-util are available on the $PATH.