1FLATPAK(1) flatpak FLATPAK(1)
2
6 flatpak - Build, install and run applications and runtimes
7
9 flatpak [OPTION...] {COMMAND}
10
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 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 System-wide remotes can be statically preconfigured by dropping
25 flatpakref files into /etc/flatpak/remotes.d/.
26 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 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 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
44 The following global options are understood. Individual commands have
45 their own options.
46 -h, --help
48 Show help options and exit.
49 -v, --verbose
51 Show debug information during command processing. Use -vv for more
52 detail.
53 --ostree-verbose
55 Show OSTree debug information during command processing.
56 --version
58 Print version information and exit.
59 --default-arch
61 Print the default arch and exit.
62 --supported-arches
64 Print the supported arches in priority order and exit.
65 --gl-drivers
67 Print the list of active gl drivers and exit.
68 --installations
70 Print paths of system installations and exit.
71
73 Commands for managing installed applications and runtimes:
74 flatpak-install(1)
76 Install an application or a runtime from a remote or bundle.
77 flatpak-update(1)
79 Update an installed application or runtime.
80 flatpak-uninstall(1)
82 Uninstall an installed application or runtime.
83 flatpak-list(1)
85 List installed applications and/or runtimes.
86 flatpak-info(1)
88 Show information for an installed application or runtime.
89 flatpak-history(1)
91 Show history.
92 flatpak-config(1)
94 Manage flatpak configuration.
95 flatpak-repair(1)
97 Repair flatpak installation.
98 flatpak-create-usb(1)
100 Copy apps and/or runtimes onto removable media.
101 Commands for finding applications and runtimes:
103 flatpak-search(1)
105 Search for applications and runtimes.
106 Commands for running applications:
108 flatpak-run(1)
110 Run an application.
111 flatpak-kill(1)
113 Stop a running application.
114 flatpak-override(1)
116 Override permissions for an application.
117 flatpak-make-current(1)
119 Specify the default version to run.
120 flatpak-enter(1)
122 Enter the namespace of a running application.
123 Commands for managing file access:
125 flatpak-document-export(1)
127 Grant an application access to a specific file.
128 flatpak-document-unexport(1)
130 Revoke access to a specific file.
131 flatpak-document-info(1)
133 Show information about a specific file.
134 flatpak-documents(1)
136 List exported files.
137 Commands for managing the dynamic permission store:
139 flatpak-permission-remove(1)
141 Remove item from permission store.
142 flatpak-permissions(1)
144 List permissions.
145 flatpak-permission-show(1)
147 Show app permissions.
148 flatpak-permission-reset(1)
150 Reset app permissions.
151 Commands for managing remote repositories:
153 flatpak-remotes(1)
155 List all configured remote repositories.
156 flatpak-remote-add(1)
158 Add a new remote repository.
159 flatpak-remote-modify(1)
161 Modify properties of a configured remote repository.
162 flatpak-remote-delete(1)
164 Delete a configured remote repository.
165 flatpak-remote-ls(1)
167 List contents of a configured remote repository.
168 flatpak-remote-info(1)
170 Show information about a ref in a configured remote repository.
171 Commands for building applications:
173 flatpak-build-init(1)
175 Initialize a build directory.
176 flatpak-build(1)
178 Run a build command in a build directory.
179 flatpak-build-finish(1)
181 Finalizes a build directory for export.
182 flatpak-build-export(1)
184 Export a build directory to a repository.
185 flatpak-build-bundle(1)
187 Create a bundle file from a ref in a local repository.
188 flatpak-build-import-bundle(1)
190 Import a file bundle into a local repository.
191 flatpak-build-sign(1)
193 Sign an application or runtime after its been exported.
194 flatpak-build-update-repo(1)
196 Update the summary file in a repository.
197 flatpak-build-commit-from(1)
199 Create a new commit based on an existing ref.
200 flatpak-repo(1)
202 Print information about a repo.
203 Commands available inside the sandbox:
205 flatpak-spawn(1)
207 Run a command in another sandbox.
208
210 File formats that are used by Flatpak commands:
211 flatpak-flatpakref(5)
213 Reference to a remote for an application or runtime
214 flatpak-flatpakrepo(5)
216 Reference to a remote
217 flatpak-remote(5)
219 Configuration for a remote
220 flatpak-installation(5)
222 Configuration for an installation location
223 flatpak-metadata(5)
225 Information about an application or runtime
226
228 Besides standard environment variables such as XDG_DATA_DIRS and
229 XDG_DATA_HOME, flatpak is consulting some of its own.
230 FLATPAK_USER_DIR
232 The location of the per-user installation. If this is not set,
233 $XDG_DATA_HOME/flatpak is used.
234 FLATPAK_SYSTEM_DIR
236 The location of the default system-wide installation. If this is
237 not set, /var/lib/flatpak is used (unless overridden at build time
238 by --localstatedir or --with-system-install-dir).
239 FLATPAK_SYSTEM_CACHE_DIR
241 The location where temporary child repositories will be created
242 during pulls into the system-wide installation. If this is not set,
243 a directory in /var/tmp/ is used. This is useful because it is more
244 likely to be on the same filesystem as the system repository (thus
245 increasing the chances for e.g. reflink copying), and we can avoid
246 filling the user's home directory with temporary data.
247 FLATPAK_CONFIG_DIR
249 The location of flatpak site configuration. If this is not set,
250 /etc/flatpak is used (unless overridden at build time by
251 --sysconfdir).
252
254 ostree(1), ostree.repo(5), flatpak-remote(5), flatpak-installation(5),
255 https://www.flatpak.org
256flatpak FLATPAK(1)