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               -d, --details
94                   Show some extra information for each extension
95
96       prefs UUID
97           Open the preference dialog of the extension identified by UUID.
98
99       create [OPTION...]
100           Creates a new extension from a template.
101
102           Options
103               --name=NAME
104                   Set the user-visible name in the extension’s metadata to
105                   NAME
106
107               --description=DESC
108                   Set the description in the extension’s metadata to DESC
109
110               --uuid=UUID
111                   Set the unique extension ID in the metadata to UUID
112
113               -i, --interactive
114                   Prompt for any extension metadata that hasn’t been provided
115                   on the command line
116
117       pack [OPTION...] [SOURCE-DIRECTORY]
118           Creates an extension bundle that is suitable for publishing.
119
120           The bundle will always include the required files extension.js and
121           metadata.json, as well as the optional stylesheet.css and prefs.js
122           if found. Each additional source that should be included must be
123           specified with --extra-source.
124
125           If the extension includes one or more GSettings schemas, they can
126           either be placed in a schemas/ folder to be picked up
127           automatically, or be specified with --schema.
128
129           Similarily, translations are included automatically when they are
130           located in a po/ folder, otherwise the --podir option can be used
131           to point to the correct directory. If no gettext domain is provided
132           on the command line, the value of the gettext-domain metadata field
133           is used if it exists, and the extension UUID if not.
134
135           All files are searched in SOURCE-DIRECTORY if specified, or the
136           current directory otherwise.
137
138           Options
139               --extra-source=FILE
140                   Additional source to include in the bundle
141
142               --schema=SCHEMA
143                   A GSettings schema that should be compiled and included
144
145               --podir=PODIR
146                   A directory with translations that should be compiled and
147                   included
148
149               --gettext-domain=DOMAIN
150                   The gettext domain to use for translations
151
152               -f, --force
153                   Overwrite an existing pack
154
155               -o, --out-dir=DIRECTORY
156                   The directory where the pack should be created
157
158       install [OPTION...] PACK
159           Installs an extension from the bundle PACK.
160
161           The command unpacks the extension files and moves them to the
162           expected location in the user’s $HOME, so that it will be loaded in
163           the next session.
164
165           It is mainly intended for testing, not as a replacement for GNOME
166           Software or the extension website. As extensions have privileged
167           access to the user’s session, it is advised to never load
168           extensions from untrusted sources without carefully reviewing their
169           content.
170
171           Options
172               --force
173                   Override an existing extension
174
175       uninstall UUID
176           Uninstalls the extension identified by UUID.
177

EXIT STATUS

179       On success 0 is returned, a non-zero failure code otherwise.
180

BUGS

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