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 identifier 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"), but this fuzzy matching
29 behavior is disabled if REF contains any slashes or periods.
30 By default this looks for both apps and runtimes with the given REF in
32 the specified REMOTE, but you can limit this by using the --app or
33 --runtime option, or by supplying the initial element in the REF.
34 If REMOTE is a uri or a path (absolute or relative starting with ./) to
36 a local repository, then that repository will be used as the source,
37 and a temporary remote will be created for the lifetime of the REF.
38 If the specified REMOTE has a collection ID configured on it, Flatpak
40 will search the sideload-repos directories configured either with the
41 --sideload-repo option, or on a per-installation or system-wide basis
42 (see flatpak(1)).
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 -u, --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. See flatpak --supported-arches for architectures supported
93 by the host.
94 --subpath=PATH
96 Install only a subpath of REF. This is mainly used to install a
97 subset of locales. This can be added multiple times to install
98 multiple subpaths.
99 --gpg-file=FILE
101 Check bundle signatures with GPG key from FILE (- for stdin).
102 --no-deploy
104 Download the latest version, but don't deploy it.
105 --no-pull
107 Don't download the latest version, deploy whatever is locally
108 available.
109 --no-related
111 Don't download related extensions, such as the locale data.
112 --no-deps
114 Don't verify runtime dependencies when installing.
115 --or-update
117 Normally install just ignores things that are already installed
118 (printing a warning), but if --or-update is specified it silently
119 turns it into an update operation instead.
120 --app
122 Assume that all REFs are apps if not explicitly specified.
123 --runtime
125 Assume that all REFs are runtimes if not explicitly specified.
126 --sideload-repo=PATH
128 Adds an extra local ostree repo as a source for installation. This
129 is equivalent to using the sideload-repos directories (see
130 flatpak(1)), but can be done on a per-command basis. Any path added
131 here is used in addition to ones in those directories.
132 --include-sdk
134 For each app being installed, also installs the SDK that was used
135 to build it. Implies --or-update; incompatible with --no-deps.
136 --include-debug
138 For each ref being installed, as well as all dependencies, also
139 installs its debug info. Implies --or-update; incompatible with
140 --no-deps.
141 -y, --assumeyes
143 Automatically answer yes to all questions (or pick the most
144 prioritized answer). This is useful for automation.
145 --noninteractive
147 Produce minimal output and avoid most questions. This is suitable
148 for use in non-interactive situations, e.g. in a build script.
149 -v, --verbose
151 Print debug information during command processing.
152 --ostree-verbose
154 Print OSTree debug information during command processing.
155
157 $ flatpak install gedit
158 $ flatpak install flathub org.gnome.gedit
160 $ flatpak --installation=default install flathub org.gnome.gedit
162 $ flatpak --user install flathub org.gnome.gedit//3.30
164 $ flatpak --user install
166 https://flathub.org/repo/appstream/org.gnome.gedit.flatpakref
167 $ flatpak --system install org.gnome.gedit.flatpakref
169
171 flatpak(1), flatpak-update(1), flatpak-list(1), flatpak-build-
172 bundle(1), flatpak-flatpakref(1), flatpak-make-current(1), ostree-find-
173 remotes(1)
174flatpak FLATPAK INSTALL(1)