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 flatpakrepo 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-mask(1)
85 Mask out updates and automatic installation
86 flatpak-list(1)
88 List installed applications and/or runtimes.
89 flatpak-info(1)
91 Show information for an installed application or runtime.
92 flatpak-history(1)
94 Show history.
95 flatpak-config(1)
97 Manage flatpak configuration.
98 flatpak-repair(1)
100 Repair flatpak installation.
101 flatpak-create-usb(1)
103 Copy apps and/or runtimes onto removable media.
104 Commands for finding applications and runtimes:
106 flatpak-search(1)
108 Search for applications and runtimes.
109 Commands for running applications:
111 flatpak-run(1)
113 Run an application.
114 flatpak-kill(1)
116 Stop a running application.
117 flatpak-override(1)
119 Override permissions for an application.
120 flatpak-make-current(1)
122 Specify the default version to run.
123 flatpak-enter(1)
125 Enter the namespace of a running application.
126 Commands for managing file access:
128 flatpak-document-export(1)
130 Grant an application access to a specific file.
131 flatpak-document-unexport(1)
133 Revoke access to a specific file.
134 flatpak-document-info(1)
136 Show information about a specific file.
137 flatpak-documents(1)
139 List exported files.
140 Commands for managing the dynamic permission store:
142 flatpak-permission-remove(1)
144 Remove item from permission store.
145 flatpak-permissions(1)
147 List permissions.
148 flatpak-permission-show(1)
150 Show app permissions.
151 flatpak-permission-reset(1)
153 Reset app permissions.
154 flatpak-permission-set(1)
156 Set app permissions.
157 Commands for managing remote repositories:
159 flatpak-remotes(1)
161 List all configured remote repositories.
162 flatpak-remote-add(1)
164 Add a new remote repository.
165 flatpak-remote-modify(1)
167 Modify properties of a configured remote repository.
168 flatpak-remote-delete(1)
170 Delete a configured remote repository.
171 flatpak-remote-ls(1)
173 List contents of a configured remote repository.
174 flatpak-remote-info(1)
176 Show information about a ref in a configured remote repository.
177 Commands for building applications:
179 flatpak-build-init(1)
181 Initialize a build directory.
182 flatpak-build(1)
184 Run a build command in a build directory.
185 flatpak-build-finish(1)
187 Finalizes a build directory for export.
188 flatpak-build-export(1)
190 Export a build directory to a repository.
191 flatpak-build-bundle(1)
193 Create a bundle file from a ref in a local repository.
194 flatpak-build-import-bundle(1)
196 Import a file bundle into a local repository.
197 flatpak-build-sign(1)
199 Sign an application or runtime after its been exported.
200 flatpak-build-update-repo(1)
202 Update the summary file in a repository.
203 flatpak-build-commit-from(1)
205 Create a new commit based on an existing ref.
206 flatpak-repo(1)
208 Print information about a repo.
209 Commands available inside the sandbox:
211 flatpak-spawn(1)
213 Run a command in another sandbox.
214
216 File formats that are used by Flatpak commands:
217 flatpak-flatpakref(5)
219 Reference to a remote for an application or runtime
220 flatpak-flatpakrepo(5)
222 Reference to a remote
223 flatpak-remote(5)
225 Configuration for a remote
226 flatpak-installation(5)
228 Configuration for an installation location
229 flatpak-metadata(5)
231 Information about an application or runtime
232
234 Besides standard environment variables such as XDG_DATA_DIRS and
235 XDG_DATA_HOME, flatpak is consulting some of its own.
236 FLATPAK_USER_DIR
238 The location of the per-user installation. If this is not set,
239 $XDG_DATA_HOME/flatpak is used.
240 FLATPAK_SYSTEM_DIR
242 The location of the default system-wide installation. If this is
243 not set, /var/lib/flatpak is used (unless overridden at build time
244 by --localstatedir or --with-system-install-dir).
245 FLATPAK_SYSTEM_CACHE_DIR
247 The location where temporary child repositories will be created
248 during pulls into the system-wide installation. If this is not set,
249 a directory in /var/tmp/ is used. This is useful because it is more
250 likely to be on the same filesystem as the system repository (thus
251 increasing the chances for e.g. reflink copying), and we can avoid
252 filling the user's home directory with temporary data.
253 FLATPAK_CONFIG_DIR
255 The location of flatpak site configuration. If this is not set,
256 /etc/flatpak is used (unless overridden at build time by
257 --sysconfdir).
258
260 ostree(1), ostree.repo(5), flatpak-remote(5), flatpak-installation(5),
261 https://www.flatpak.org
262flatpak FLATPAK(1)