1FLATPAK INSTALL(1) flatpak install FLATPAK INSTALL(1)
2
6 flatpak-install - Install an application or runtime
7
9 flatpak install [OPTION...] [REMOTE] REF...
10 flatpak install [OPTION...] [--from|--bundle] LOCATION
12
14 Installs an application or runtime. The primary way to install is to
15 specify a REMOTE name as the source and one ore more REFs to specify
16 the application or runtime to install. If REMOTE is omitted, the
17 configured remotes are searched for the first REF and the user is asked
18 to confirm the resulting choice.
19 Each REF argument is a full or partial indentifier in the flatpak ref
21 format, which looks like "(app|runtime)/ID/ARCH/BRANCH". All elements
22 except ID are optional and can be left out, including the slashes, so
23 most of the time you need only specify ID. Any part left out will be
24 matched against what is in the remote, and if there are multiple
25 matches you will be prompted to choose one of them. You will also be
26 prompted with choices if REF doesn't match anything in the remote
27 exactly but is similar to one or more refs in the remote (e.g.
28 "devhelp" is similar to "org.gnome.Devhelp").
29 By default this looks for both apps and runtimes with the given REF in
31 the specified REMOTE, but you can limit this by using the --app or
32 --runtime option, or by supplying the initial element in the REF.
33 If REMOTE is a uri or a path (absolute or relative starting with ./) to
35 a local repository, then that repository will be used as the source,
36 and a temporary remote will be created for the lifetime of the REF.
37 If the specified REMOTE has a collection ID configured on it, flatpak
39 will search mounted filesystems such as USB drives as well as Avahi
40 services advertised on the local network for the needed refs, in order
41 to support offline updates. See ostree-find-remotes(1) for more
42 information.
43 The alternative form of the command (with --from or --bundle) allows to
45 install directly from a source such as a .flatpak single-file bundle or
46 a .flatpakref application description. The options are optional if the
47 first argument has the expected filename extension.
48 Note that flatpak allows to have multiple branches of an application
50 and runtimes installed and used at the same time. However, only one
51 version of an application can be current, meaning its exported files
52 (for instance desktop files and icons) are visible to the host. The
53 last installed version is made current by default, but this can
54 manually changed with flatpak make-current.
55 Unless overridden with the --user or the --installation option, this
57 command installs the application or runtime in the default system-wide
58 installation.
59
61 The following options are understood:
62 -h, --help
64 Show help options and exit.
65 --bundle
67 Treat LOCATION as a single-bundle file. This is assumed if the
68 argument ends with .flatpak.
69 --from
71 Treat LOCATION as an application description file. This is assumed
72 if the argument ends with .flatpakref.
73 --reinstall
75 Uninstall first if already installed.
76 --user
78 Install the application or runtime in a per-user installation.
79 --system
81 Install the application or runtime in the default system-wide
82 installation.
83 --installation=NAME
85 Install the application or runtime in a system-wide installation
86 specified by NAME among those defined in
87 /etc/flatpak/installations.d/. Using --installation=default is
88 equivalent to using --system.
89 --arch=ARCH
91 The default architecture to install for, if not given explicitly in
92 the REF.
93 --subpath=PATH
95 Install only a subpath of REF. This is mainly used to install a
96 subset of locales. This can be added multiple times to install
97 multiple subpaths.
98 --gpg-file=FILE
100 Check bundle signatures with GPG key from FILE (- for stdin).
101 --no-deploy
103 Download the latest version, but don't deploy it.
104 --no-pull
106 Don't download the latest version, deploy whatever is locally
107 available.
108 --no-related
110 Don't download related extensions, such as the locale data.
111 --no-deps
113 Don't verify runtime dependencies when installing.
114 --app
116 Assume that all REFs are apps if not explicitly specified.
117 --runtime
119 Assume that all REFs are runtimes if not explicitly specified.
120 -y, --assumeyes
122 Automatically answer yes to all questions (or pick the most
123 prioritized answer). This is useful for automation.
124 --noninteractive
126 Produce minimal output and avoid most questions. This is suitable
127 for use in non-interactive situations, e.g. in a build script.
128 -v, --verbose
130 Print debug information during command processing.
131 --ostree-verbose
133 Print OSTree debug information during command processing.
134
136 $ flatpak install gnome org.gnome.gedit2
137 $ flatpak --installation=default install gnome org.gnome.gedit2
139 $ flatpak --user install gnome org.gnome.gedit//3.22
141 $ flatpak --user install https://sdk.gnome.org/gedit.flatpakref
143
145 flatpak(1), flatpak-update(1), flatpak-list(1), flatpak-build-
146 bundle(1), flatpak-flatpakref(1), flatpak-make-current(1), ostree-find-
147 remotes(1)
148flatpak FLATPAK INSTALL(1)