1GNOME-EXTENSIONS(1) User Commands GNOME-EXTENSIONS(1)
2
6 gnome-extensions - Command line tool for managing GNOME extensions
7
9 gnome-extensions help [COMMAND]
10 gnome-extensions version
12 gnome-extensions enable UUID
14 gnome-extensions disable UUID
16 gnome-extensions reset UUID
18 gnome-extensions info UUID
20 gnome-extensions show UUID
22 gnome-extensions list [OPTION...]
24 gnome-extensions prefs UUID
26 gnome-extensions create [OPTION...]
28 gnome-extensions pack [OPTION...]
30 gnome-extensions install [OPTION...] PACK
32 gnome-extensions uninstall UUID
34
36 gnome-extensions is a utility that makes some common GNOME extensions
37 operations available on the command line.
38
40 All commands except for help and version handle the following options:
41 --quiet, -q
43 Do not print error messages
44
46 help [COMMAND]
47 Displays a short synopsis of the available commands or provides
48 detailed help on a specific command.
49 version
51 Prints the program version.
52 enable UUID
54 Enables the extension identified by UUID.
55 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 If the extension is already enabled, the command will do nothing.
61 disable UUID
63 Disables the extension identified by UUID.
64 If the extension is not enabled, the command will do nothing.
66 reset UUID
68 Reset the extension identified by UUID.
69 The extension will be disabled in GNOME, but may be enabled by
71 other sessions like GNOME Classic.
72 info UUID
74 Show details of the extension identified by UUID, including name,
75 description and state.
76 show UUID
78 Synonym of info.
79 list [OPTION...]
81 Displays a list of installed extensions.
82 Options
84 --user
85 Include extensions installed in the user’s $HOME
86 --system
88 Include extensions installed in the system
89 --enabled
91 Include enabled extensions
92 --disabled
94 Include disabled extensions
95 --prefs
97 Only include extensions with preferences
98 --updates
100 Only include extensions with pending updates
101 -d, --details
103 Show some extra information for each extension
104 prefs UUID
106 Open the preference dialog of the extension identified by UUID.
107 create [OPTION...]
109 Creates a new extension from a template.
110 Options
112 --name=NAME
113 Set the user-visible name in the extension’s metadata to
114 NAME
115 --description=DESC
117 Set the description in the extension’s metadata to DESC
118 --uuid=UUID
120 Set the unique extension ID in the metadata to UUID
121 --template=TEMPLATE
123 Use TEMPLATE as base for the new extension
124 -i, --interactive
126 Prompt for any extension metadata that hasn’t been provided
127 on the command line
128 pack [OPTION...] [SOURCE-DIRECTORY]
130 Creates an extension bundle that is suitable for publishing.
131 The bundle will always include the required files extension.js and
133 metadata.json, as well as the optional stylesheet.css and prefs.js
134 if found. Each additional source that should be included must be
135 specified with --extra-source.
136 If the extension includes one or more GSettings schemas, they can
138 either be placed in a schemas/ folder to be picked up
139 automatically, or be specified with --schema.
140 Similarily, translations are included automatically when they are
142 located in a po/ folder, otherwise the --podir option can be used
143 to point to the correct directory. If no gettext domain is provided
144 on the command line, the value of the gettext-domain metadata field
145 is used if it exists, and the extension UUID if not.
146 All files are searched in SOURCE-DIRECTORY if specified, or the
148 current directory otherwise.
149 Options
151 --extra-source=FILE
152 Additional source to include in the bundle
153 --schema=SCHEMA
155 A GSettings schema that should be compiled and included
156 --podir=PODIR
158 A directory with translations that should be compiled and
159 included
160 --gettext-domain=DOMAIN
162 The gettext domain to use for translations
163 -f, --force
165 Overwrite an existing pack
166 -o, --out-dir=DIRECTORY
168 The directory where the pack should be created
169 install [OPTION...] PACK
171 Installs an extension from the bundle PACK.
172 The command unpacks the extension files and moves them to the
174 expected location in the user’s $HOME, so that it will be loaded in
175 the next session.
176 It is mainly intended for testing, not as a replacement for the
178 extension website. As extensions have privileged access to the
179 user’s session, it is advised to never load extensions from
180 untrusted sources without carefully reviewing their content.
181 Options
183 --force
184 Override an existing extension
185 uninstall UUID
187 Uninstalls the extension identified by UUID.
188
190 On success 0 is returned, a non-zero failure code otherwise.
191
193 The tool is part of the gnome-shell project, and bugs should be
194 reported in its issue tracker at
195 https://gitlab.gnome.org/GNOME/gnome-shell/issues.
196GNOME-EXTENSIONS-TOOL August 2018 GNOME-EXTENSIONS(1)