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

COMMON OPTIONS

40       All commands except for help and version handle the following options:
41
42       --quiet, -q
43           Do not print error messages
44

COMMANDS

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

EXIT STATUS

200       On success 0 is returned, a non-zero failure code otherwise.
201

BUGS

203       The tool is part of the gnome-shell project, and bugs should be
204       reported in its issue tracker at
205       https://gitlab.gnome.org/GNOME/gnome-shell/issues.
206
207
208
209GNOME-EXTENSIONS-TOOL             August 2018              GNOME-EXTENSIONS(1)