1FLATPAK INSTALL(1) flatpak install FLATPAK INSTALL(1)
2
3
4
6 flatpak-install - Install an application or runtime
7
9 Install from a configured remote:
10
11 flatpak install [OPTION...] REMOTE-NAME REF...
12
13 Install from a .flatpakref file:
14
15 flatpak install [OPTION...] [--from] LOCATION
16
17 Install from a .flatpak bundle:
18
19 flatpak install [OPTION...] [--bundle] FILENAME
20
22 Installs an application or runtime. The primary way to install is to
23 specify a [REMOTE] name as the source and one ore more [REF]s to
24 specify the application or runtime to install.
25
26 Each REF argument is a full or partial indentifier in the flatpak ref
27 format, which looks like "(app|runtime)/ID/ARCH/BRANCH". All elements
28 except ID are optional and can be left out, including the slashes, so
29 most of the time you need only specify ID. Any part left out will be
30 matched against what is in the remote, and if there are multiple
31 matches an error message will list the alternatives.
32
33 By default this looks for both apps and runtimes with the given REF in
34 the specified REMOTE, but you can limit this by using the --app or
35 --runtime option, or by supplying the initial element in the REF.
36
37 If REMOTE is a uri or a path (absolute or relative starting with ./) to
38 a local repository, then that repository will be used as the source,
39 and a temporary remote will be created for the lifetime of the REF.
40
41 If the specified REMOTE has a collection ID configured on it, flatpak
42 will search mounted filesystems such as USB drives as well as Avahi
43 services advertised on the local network for the needed refs, in order
44 to support offline updates. See ostree-find-remotes(1) for more
45 information.
46
47 The alternative form of the command ([--from] or [--bundle] allows you
48 to install directly from a source such as a .flatpak single-file
49 bundle, a .flatpakref app description. The options are optional if the
50 first argument has the right extension.
51
52 Note that flatpak allows one to have multiple branches of an
53 application and runtimes installed and used at the same time. However,
54 only one version of an application can be current, meaning its exported
55 files (for instance desktop files and icons) are visible to the host.
56 The last installed version is made current by default, but you can
57 manually change with make-current.
58
59 Unless overridden with the --user or the --installation option, this
60 command installs the application or runtime in the default system-wide
61 installation.
62
64 The following options are understood:
65
66 -h, --help
67 Show help options and exit.
68
69 --bundle
70 Assume LOCATION is a .flatpak single-bundle file. This is optional
71 if the arguments ends with .flatpak.
72
73 --from
74 Assume LOCATION is a .flatpakref file containing the details of the
75 app to be installed. This is optional if the arguments ends with
76 .flatpakref.
77
78 --reinstall
79 Uninstall first if already installed.
80
81 --user
82 Install the application or runtime in a per-user installation.
83
84 --system
85 Install the application or runtime in the default system-wide
86 installation.
87
88 --installation=NAME
89 Install the application or runtime in a system-wide installation
90 specified by NAME among those defined in
91 /etc/flatpak/installations.d/. Using --installation=default is
92 equivalent to using --system.
93
94 --arch=ARCH
95 The default architecture to install for, if not given explicitly in
96 the REF.
97
98 --subpath=PATH
99 Install only a subpath of the ref. This is mainly used to install a
100 subset of locales. This can be added multiple times to install
101 multiple subpaths.,
102
103 --gpg-file=FILE
104 Check bundle signatures with GPG key from FILE (- for stdin).
105
106 --no-deploy
107 Download the latest version, but don't deploy it.
108
109 --no-pull
110 Don't download the latest version, deploy whatever is locally
111 available.
112
113 --no-related
114 Don't download related extensions, such as the locale data.
115
116 --no-deps
117 Don't verify runtime dependencies when installing.
118
119 --app
120 Assume that all REFs are apps if not explicitly specified.
121
122 --runtime
123 Assume that all REFs are runtimes if not explicitly specified.
124
125 -y, --assumeyes
126 Automatically answer yes to all questions (or pick the most
127 prioritized answer). This is useful for automation.
128
129 -v, --verbose
130 Print debug information during command processing.
131
132 --ostree-verbose
133 Print OSTree debug information during command processing.
134
136 $ flatpak install gnome org.gnome.gedit2
137
138 $ flatpak --installation=default install gnome org.gnome.gedit2
139
140 $ flatpak --user install gnome org.gnome.gedit//3.22
141
142 $ 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)
147
148
149
150flatpak FLATPAK INSTALL(1)