1GNOME-EXTENSIONS(1)              User Commands             GNOME-EXTENSIONS(1)
2
3
4

NAME

6       gnome-extensions - Command line tool for managing GNOME extensions
7

SYNOPSIS

9       gnome-extensions help [COMMAND]
10
11       gnome-extensions version
12
13       gnome-extensions enable UUID
14
15       gnome-extensions disable UUID
16
17       gnome-extensions reset UUID
18
19       gnome-extensions info UUID
20
21       gnome-extensions show UUID
22
23       gnome-extensions list [OPTION...]
24
25       gnome-extensions prefs UUID
26
27       gnome-extensions create [OPTION...]
28
29       gnome-extensions pack [OPTION...]
30
31       gnome-extensions install [OPTION...] PACK
32
33       gnome-extensions uninstall UUID
34

DESCRIPTION

36       gnome-extensions is a utility that makes some common GNOME extensions
37       operations available on the command line.
38

COMMANDS

40       help [COMMAND]
41           Displays a short synopsis of the available commands or provides
42           detailed help on a specific command.
43
44       version
45           Prints the program version.
46
47       enable UUID
48           Enables the extension identified by UUID.
49
50           The command will not detect any errors from the extension itself,
51           use the info command to confirm that the extension state is
52           ENABLED.
53
54           If the extension is already enabled, the command will do nothing.
55
56       disable UUID
57           Disables the extension identified by UUID.
58
59           If the extension is not enabled, the command will do nothing.
60
61       reset UUID
62           Reset the extension identified by UUID.
63
64           The extension will be disabled in GNOME, but may be enabled by
65           other sessions like GNOME Classic.
66
67       info UUID
68           Show details of the extension identified by UUID, including name,
69           description and state.
70
71       show UUID
72           Synonym of info.
73
74       list [OPTION...]
75           Displays a list of installed extensions.
76
77           Options
78               --user
79                   Include extensions installed in the user’s $HOME
80
81               --system
82                   Include extensions installed in the system
83
84               --enabled
85                   Include enabled extensions
86
87               --disabled
88                   Include disabled extensions
89
90               --prefs
91                   Only include extensions with preferences
92
93               --updates
94                   Only include extensions with pending updates
95
96               -d, --details
97                   Show some extra information for each extension
98
99       prefs UUID
100           Open the preference dialog of the extension identified by UUID.
101
102       create [OPTION...]
103           Creates a new extension from a template.
104
105           Options
106               --name=NAME
107                   Set the user-visible name in the extension’s metadata to
108                   NAME
109
110               --description=DESC
111                   Set the description in the extension’s metadata to DESC
112
113               --uuid=UUID
114                   Set the unique extension ID in the metadata to UUID
115
116               -i, --interactive
117                   Prompt for any extension metadata that hasn’t been provided
118                   on the command line
119
120       pack [OPTION...] [SOURCE-DIRECTORY]
121           Creates an extension bundle that is suitable for publishing.
122
123           The bundle will always include the required files extension.js and
124           metadata.json, as well as the optional stylesheet.css and prefs.js
125           if found. Each additional source that should be included must be
126           specified with --extra-source.
127
128           If the extension includes one or more GSettings schemas, they can
129           either be placed in a schemas/ folder to be picked up
130           automatically, or be specified with --schema.
131
132           Similarily, translations are included automatically when they are
133           located in a po/ folder, otherwise the --podir option can be used
134           to point to the correct directory. If no gettext domain is provided
135           on the command line, the value of the gettext-domain metadata field
136           is used if it exists, and the extension UUID if not.
137
138           All files are searched in SOURCE-DIRECTORY if specified, or the
139           current directory otherwise.
140
141           Options
142               --extra-source=FILE
143                   Additional source to include in the bundle
144
145               --schema=SCHEMA
146                   A GSettings schema that should be compiled and included
147
148               --podir=PODIR
149                   A directory with translations that should be compiled and
150                   included
151
152               --gettext-domain=DOMAIN
153                   The gettext domain to use for translations
154
155               -f, --force
156                   Overwrite an existing pack
157
158               -o, --out-dir=DIRECTORY
159                   The directory where the pack should be created
160
161       install [OPTION...] PACK
162           Installs an extension from the bundle PACK.
163
164           The command unpacks the extension files and moves them to the
165           expected location in the user’s $HOME, so that it will be loaded in
166           the next session.
167
168           It is mainly intended for testing, not as a replacement for GNOME
169           Software or the extension website. As extensions have privileged
170           access to the user’s session, it is advised to never load
171           extensions from untrusted sources without carefully reviewing their
172           content.
173
174           Options
175               --force
176                   Override an existing extension
177
178       uninstall UUID
179           Uninstalls the extension identified by UUID.
180

EXIT STATUS

182       On success 0 is returned, a non-zero failure code otherwise.
183

BUGS

185       The tool is part of the gnome-shell project, and bugs should be
186       reported in its issue tracker at
187       https://gitlab.gnome.org/GNOME/gnome-shell/issues.
188
189
190
191GNOME-EXTENSIONS-TOOL             August 2018              GNOME-EXTENSIONS(1)
Impressum