Guidelines and HOWTOs/AppStream

Jump to: navigation, search

Quick guide on how to AppStream your app. For a more in-depth overview hop on over to Techbase.


  1. Make sure your desktop file is reverse-domain-notation i.e.
    1. Your desktop file should be This is also your desktop-id, so whenver you may need that. It's basically your file name.
    2. If you have a dbus service ... make sure that your dbus service name matches this or change your desktop file to match the service address (whichever seems more appropriate)
    3. The name part 'foo' MUST be the name of your binary or you need to use KAboutData::setDesktopFileName() to set the desktop file name you are using
  2. Create in your source tree
  3. Paste the template you can find below into that file
  4. Make sure you replaced all place holders from the template
  5. Take some screenshots and put them in the git repo kde:websites/product-screenshots (note the readme)
  6. Add your screenshots to the appdata.xml file.
  7. Install the file via CMake (KDE_INSTALL_METAINFODIR is defined by KDEInstallDirs from extra-cmake-modules)
  8. Validate your appdata using the appstreamcli helper
    appstreamcli validate
  9. Validate your installed tree using the helper in your build directory
    make install DESTDIR=root
    appstreamcli validate-tree root
    rm -r root
  10. If all looks good commit and push
  11. If you have any questions submit a review and make sure to subscribe sitter and mak


Carefully review all fields and replace $NAME with your application name as seen in the reverse domain notation. Where appropriate the fields have URLs of AppStream documentation to help you find out what to put there.

<?xml version="1.0" encoding="utf-8"?>
<component type="desktop">
  <project_license> </project_license>
  <summary> </summary>
    <p> </p>
  <url type="homepage"></url>
  <url type="bugtracker"></url>
  <url type="donation"></url>
    <screenshot type="default">
        Central hosting at

Content is available under Creative Commons License SA 4.0 unless otherwise noted.