flatpak(1)

1FLATPAK(1)                          flatpak                         FLATPAK(1)
2
3
4

NAME

6       flatpak - Build, install and run applications and runtimes
7

SYNOPSIS

9       flatpak [OPTION...] {COMMAND}
10

DESCRIPTION

12       Flatpak is a tool for managing applications and the runtimes they use.
13       In the Flatpak model, applications can be built and distributed
14       independently from the host system they are used on, and they are
15       isolated from the host system ('sandboxed') to some degree, at runtime.
16
17       Flatpak can operate in system-wide or per-user mode. The system-wide
18       data (runtimes, applications and configuration) is located in
19       $prefix/var/lib/flatpak/, and the per-user data is in
20       $HOME/.local/share/flatpak/. Below these locations, there is a local
21       repository in the repo/ subdirectory and installed runtimes and
22       applications are in the corresponding runtime/ and app/ subdirectories.
23
24       System-wide remotes can be statically preconfigured by dropping
25       flatpakrepo files into /etc/flatpak/remotes.d/.
26
27       In addition to the system-wide installation in
28       $prefix/var/lib/flatpak/, which is always considered the default one
29       unless overridden, more system-wide installations can be defined via
30       configuration files in /etc/flatpak/installations.d/, which must define
31       at least the id of the installation and the absolute path to it. Other
32       optional parameters like DisplayName, Priority or StorageType are also
33       supported.
34
35       Flatpak uses OSTree to distribute and deploy data. The repositories it
36       uses are OSTree repositories and can be manipulated with the ostree
37       utility. Installed runtimes and applications are OSTree checkouts.
38
39       Basic commands for building flatpaks such as build-init, build and
40       build-finish are included in the flatpak utility. For higher-level
41       build support, see the separate flatpak-builder(1) tool.
42
43       Flatpak supports installing from sideload repos. These are partial
44       copies of a repository (generated by flatpak create-usb) that are used
45       as an installation source when offline (and online as a performance
46       improvement). Such repositories are configured by creating symlinks to
47       the sideload sources in the sideload-repos subdirectory of the
48       installation directory (i.e. typically /var/lib/flatpak/sideload-repos
49       or ~/.local/share/flatpak/sideload-repos). Additionally symlinks can be
50       created in /run/flatpak/sideload-repos which is a better location for
51       non-persistent sources (as it is cleared on reboot). These symlinks can
52       point to either the directory given to flatpak create-usb which by
53       default writes to the subpath .ostree/repo, or directly to an ostree
54       repo.
55

OPTIONS

57       The following global options are understood. Individual commands have
58       their own options.
59
60       -h, --help
61           Show help options and exit.
62
63       -v, --verbose
64           Show debug information during command processing. Use -vv for more
65           detail.
66
67       --ostree-verbose
68           Show OSTree debug information during command processing.
69
70       --version
71           Print version information and exit.
72
73       --default-arch
74           Print the default arch and exit.
75
76       --supported-arches
77           Print the supported arches in priority order and exit.
78
79       --gl-drivers
80           Print the list of active gl drivers and exit.
81
82       --installations
83           Print paths of system installations and exit.
84
85       --print-system-only
86           When the flatpak --print-updated-env command is run, only print the
87           environment for system flatpak installations, not including the
88           user’s home installation.
89
90       --print-updated-env
91           Print the set of environment variables needed to use flatpaks,
92           amending the current set of environment variables. This is intended
93           to be used in a systemd environment generator, and should not need
94           to be run manually.
95

COMMANDS

97       Commands for managing installed applications and runtimes:
98
99       flatpak-install(1)
100           Install an application or a runtime from a remote or bundle.
101
102       flatpak-update(1)
103           Update an installed application or runtime.
104
105       flatpak-uninstall(1)
106           Uninstall an installed application or runtime.
107
108       flatpak-mask(1)
109           Mask out updates and automatic installation.
110
111       flatpak-pin(1)
112           Pin runtimes to prevent automatic removal.
113
114       flatpak-list(1)
115           List installed applications and/or runtimes.
116
117       flatpak-info(1)
118           Show information for an installed application or runtime.
119
120       flatpak-history(1)
121           Show history.
122
123       flatpak-config(1)
124           Manage flatpak configuration.
125
126       flatpak-repair(1)
127           Repair flatpak installation.
128
129       flatpak-create-usb(1)
130           Copy apps and/or runtimes onto removable media.
131
132       Commands for finding applications and runtimes:
133
134       flatpak-search(1)
135           Search for applications and runtimes.
136
137       Commands for managing running applications:
138
139       flatpak-run(1)
140           Run an application.
141
142       flatpak-kill(1)
143           Stop a running application.
144
145       flatpak-override(1)
146           Override permissions for an application.
147
148       flatpak-make-current(1)
149           Specify the default version to run.
150
151       flatpak-enter(1)
152           Enter the namespace of a running application.
153
154       Commands for managing file access:
155
156       flatpak-document-export(1)
157           Grant an application access to a specific file.
158
159       flatpak-document-unexport(1)
160           Revoke access to a specific file.
161
162       flatpak-document-info(1)
163           Show information about a specific file.
164
165       flatpak-documents(1)
166           List exported files.
167
168       Commands for managing the dynamic permission store:
169
170       flatpak-permission-remove(1)
171           Remove item from permission store.
172
173       flatpak-permissions(1)
174           List permissions.
175
176       flatpak-permission-show(1)
177           Show app permissions.
178
179       flatpak-permission-reset(1)
180           Reset app permissions.
181
182       flatpak-permission-set(1)
183           Set app permissions.
184
185       Commands for managing remote repositories:
186
187       flatpak-remotes(1)
188           List all configured remote repositories.
189
190       flatpak-remote-add(1)
191           Add a new remote repository.
192
193       flatpak-remote-modify(1)
194           Modify properties of a configured remote repository.
195
196       flatpak-remote-delete(1)
197           Delete a configured remote repository.
198
199       flatpak-remote-ls(1)
200           List contents of a configured remote repository.
201
202       flatpak-remote-info(1)
203           Show information about a ref in a configured remote repository.
204
205       Commands for building applications:
206
207       flatpak-build-init(1)
208           Initialize a build directory.
209
210       flatpak-build(1)
211           Run a build command in a build directory.
212
213       flatpak-build-finish(1)
214           Finalizes a build directory for export.
215
216       flatpak-build-export(1)
217           Export a build directory to a repository.
218
219       flatpak-build-bundle(1)
220           Create a bundle file from a ref in a local repository.
221
222       flatpak-build-import-bundle(1)
223           Import a file bundle into a local repository.
224
225       flatpak-build-sign(1)
226           Sign an application or runtime after its been exported.
227
228       flatpak-build-update-repo(1)
229           Update the summary file in a repository.
230
231       flatpak-build-commit-from(1)
232           Create a new commit based on an existing ref.
233
234       flatpak-repo(1)
235           Print information about a repo.
236
237       Commands available inside the sandbox:
238
239       flatpak-spawn(1)
240           Run a command in another sandbox.
241

FILE FORMATS

243       File formats that are used by Flatpak commands:
244
245       flatpak-flatpakref(5)
246           Reference to a remote for an application or runtime
247
248       flatpak-flatpakrepo(5)
249           Reference to a remote
250
251       flatpak-remote(5)
252           Configuration for a remote
253
254       flatpak-installation(5)
255           Configuration for an installation location
256
257       flatpak-metadata(5)
258           Information about an application or runtime
259

ENVIRONMENT

261       Besides standard environment variables such as XDG_DATA_DIRS and
262       XDG_DATA_HOME, flatpak is consulting some of its own.
263
264       FLATPAK_USER_DIR
265           The location of the per-user installation. If this is not set,
266           $XDG_DATA_HOME/flatpak is used.
267
268       FLATPAK_SYSTEM_DIR
269           The location of the default system-wide installation. If this is
270           not set, /var/lib/flatpak is used (unless overridden at build time
271           by --localstatedir or --with-system-install-dir).
272
273       FLATPAK_SYSTEM_CACHE_DIR
274           The location where temporary child repositories will be created
275           during pulls into the system-wide installation. If this is not set,
276           a directory in /var/tmp/ is used. This is useful because it is more
277           likely to be on the same filesystem as the system repository (thus
278           increasing the chances for e.g. reflink copying), and we can avoid
279           filling the user's home directory with temporary data.
280
281       FLATPAK_CONFIG_DIR
282           The location of flatpak site configuration. If this is not set,
283           /etc/flatpak is used (unless overridden at build time by
284           --sysconfdir).
285
286       FLATPAK_RUN_DIR
287           The location of flatpak runtime global files. If this is not set,
288           /run/flatpak is used.
289