appstreamcli - Handle AppStream metadata formats and query AppStream data
This manual page documents briefly the appstreamcli command.
appstreamcli is a small helper tool to work with AppStream metadata and access the AppStream component index from the command-line. The AppStream component index contains a list of all available software components for your distribution, matched to their package names. It is generated using AppStream XML or Debian DEP-11 data, which is provided by your distributor.
For more information about the AppStream project and the other components which are part of it, take a look at the AppStream pages at Freedesktop.org.
s, search TERM
what-provides TYPE TERM
Get components which handle the "text/xml" mediatype.
appstreamcli what-provides mediatype "text/xml"
Get component which provides the "libfoo.so.2" library.
appstreamcli what-provides lib libfoo.so.2
This command must be executed with root permission.
Both XML metadata types, upstream and distro XML, are handled. The format type which should be validated is determined automatically.
The --pedantic flag triggers a more pedantic validation of the file, including minor and style issues in the report.
This performs a standard validation of all found metadata, but also checks for additional errors, like the presence of .desktop files and validity of other additional metadata.
This will check whether the license string is considered to be valid for AppStream, and return a non-zero exit code if it is not. The command will also display useful information like the canonical ID of a license, whether it is suitable as license for AppStream metadata, and whether the license is considered to be for Free and Open Source software or proprietary software.
AppStream will consider any license as Free and Open Source that is marked as suitable by either the Free Software Foundation (FSF), Open Source Initiative (OSI) or explicit license list of the Debian Free Software Guidelines (DFSG).
This resolves the AppStream component ID to an installation candidate and then calls either the native package manager or Flatpak (if available) to install the component.
This will uninstall software matching the selected ID using either the native package manager or Flatpak (if available).
compare-versions, vercmp VER1 [CMP] VER2
If a version number, a comparison operator and another version number are passed in as parameter, the result of the comparison operation will be printed to stdout, and appstreamcli will exit with a non-zero exit status in case the comparison failed. The comparison operator can be one of the following:
new-template TYPE FILE
The generated files contain example entries which need to be filed in with the actual desired values by the project author.
The first TYPE parameter is the name of an AppStream component type. For a complete list check out the documentation or the help output of appstreamcli for this subcommand.
make-desktop-file MI_FILE DESKTOP_FILE
This command will use the first binary mentioned in a provides tag of the component for the Exec= field of the new desktop-entry file. If this is not the desired behavior, the --exec flag can be used to explicitly define a binary to launch. Other methods of launching the application are currently not supported.
In order to generate a proper desktop-entry, this command assumes that not only the minimally required tags for an AppStream component are set, but also that it has an <icon/> tag of type "stock" to describe the stock icon that should be used as well as a <categories/> tag containing the categories the application should be placed in.
news-to-metainfo NEWS_FILE MI_FILE [OUT_FILE]
The --format option can be used to enforce reading the input file in a specific format ("text" or "yaml") in case the format autodetection fails. The --limit option is used to limit the amount of release entries written (the newest entries will always be first).
metainfo-to-news MI_FILE NEWS_FILE
The --format option can be used to explicitly specify the output format ("yaml" or "text"). If it is not set, appstreamcli will guess which format is most suitable.
convert FILE1 FILE1
The same effect can be achieved by setting the AS_VALIDATE_NONET environment variable before running appstreamcli.
This manual page was written by Matthias Klumpp <email@example.com>.
Copyright © 2012-2022 Matthias Klumpp
- the documentation