1APPSTREAMCLI(1)                  appstreamcli                  APPSTREAMCLI(1)
2
3
4

NAME

6       appstreamcli - Handle AppStream metadata and the AppStream index
7

SYNOPSIS

9       appstreamcli [COMMAND]
10

DESCRIPTION

12       This manual page documents briefly the appstreamcli command.
13
14       appstreamcli is a small helper tool to work with AppStream metadata and
15       access the AppStream component index from the command-line. The
16       AppStream component index contains a list of all available software
17       components for your distribution, matched to their package names. It is
18       generated using AppStream XML or Debian DEP-11 data, which is provided
19       by your distributor.
20
21       For more information about the AppStream project and the other
22       components which are part of it, take a look at the AppStream pages at
23       Freedesktop.org[1].
24

OPTIONS

26       status
27           Display various information about the installed metadata and the
28           metadata cache.
29
30       get ID
31           Get a component by it's identifier.
32
33       s, search TERM
34           Search the AppStream component database for a given search term.
35
36       what-provides TYPE TERM
37           Return components which provide a given item. An item type can be
38           specified using the TYPE parameter, a value to search for has to be
39           supplied using the TERM parameter.
40
41           Examples:
42
43           Get components which handle the "text/xml" mimetype.
44
45           appstreamcli what-provides mimetype "text/xml"
46
47           Get component which provides the "libfoo.so.2" library.
48
49           appstreamcli what-provides lib libfoo.so.2
50
51       refresh, refresh-cache
52           Trigger a database refresh, if necessary. In case you want to force
53           the database to be rebuilt, supply the --force flag.
54
55           This command must be executed with root permission.
56
57       dump ID
58           Dump the XML description of a component with the given ID.
59
60       validate FILES
61           Validate AppStream XML metadata for compliance with the
62           specification.
63
64           Both XML metadata types, upstream and distro XML, are handled. The
65           filetype which should be validated is determined automatically.
66
67           The --pedantic flag triggers a more pedantic validation of the
68           file, including minor and style issues in the report.
69
70       validate-tree DIRECTORY
71           Validate AppStream XML metadata found in a file-tree.
72
73           This performs a standard validation of all found metadata, but also
74           checks for additional errors, like the presence of .desktop files
75           and validity of other additional metadata.
76
77       install ID
78           Install a software component by its ID.
79
80           This resolves the AppStream component ID to the package name which
81           provides it and then calls the distribution's package manager to
82           install the software.
83
84           This feature is experimental.
85
86       put FILE
87           Install a metadata file into the right directory on the current
88           machine.
89
90       compare-versions VER1 [CMP] VER2
91           Compare two version numbers. If two version numbers are given as
92           parameters, the versions will be compared and the comparison result
93           will be printed to stdout.
94
95           If a version number, a comparison operator and another version
96           number are passed in as parameter, the result of the comparison
97           operation will be printed to stdout, and appstreamcli will exit
98           with a non-zero exit status in case the comparison failed. The
99           comparison operator can be one of the following:
100
101           ·   eq - Equal to
102
103           ·   ne - Not equal to
104
105           ·   lt - Lesser than
106
107           ·   gt - Greater than
108
109           ·   le - Lesser than or equal to
110
111           ·   ge - Greater than or equal to
112
113       new-template TYPE FILE
114           Create a metainfo file template to be used by software projects.
115           The --from-desktop option can be used to use a .desktop file as
116           template for generating the example file.
117
118           The generated files contain example entries which need to be filed
119           in with the actual desired values by the project author.
120
121           The first TYPE parameter is the name of an AppStream component
122           type. For a complete list check out the documentation[2] or the
123           help output of appstreamcli for this subcommand.
124
125       --details
126           Print out more information about a found component.
127
128       --no-color
129           Don't print colored output.
130
131       --no-net
132           Do not access the network when validating metadata.
133
134           The same effect can be achieved by setting the AS_VALIDATE_NONET
135           environment variable before running appstreamcli.
136
137       --version
138           Display the version number of appstreamcli
139

SEE ALSO

141       pkcon (1).
142

AUTHOR

144       This manual page was written by Matthias Klumpp
145       <matthias@tenstral.net>.
146

COPYRIGHT

148       Copyright © 2012-2018 Matthias Klumpp
149

NOTES

151        1. Freedesktop.org
152           http://www.freedesktop.org/wiki/Distributions/AppStream/
153
154        2. the documentation
155           https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html
156
157
158
159AppStream                                                      APPSTREAMCLI(1)