table of contents
GNOME-EXTENSIONS(1) | User Commands | GNOME-EXTENSIONS(1) |
NAME¶
gnome-extensions - Command line tool for managing GNOME extensions
SYNOPSIS¶
gnome-extensions help [COMMAND]
gnome-extensions version
gnome-extensions enable UUID
gnome-extensions disable UUID
gnome-extensions reset UUID
gnome-extensions info UUID
gnome-extensions show UUID
gnome-extensions list [OPTION...]
gnome-extensions prefs UUID
gnome-extensions create [OPTION...]
gnome-extensions pack [OPTION...]
gnome-extensions install [OPTION...] PACK
gnome-extensions uninstall UUID
DESCRIPTION¶
gnome-extensions is a utility that makes some common GNOME extensions operations available on the command line.
COMMON OPTIONS¶
All commands except for help and version handle the following options:
--quiet, -q
COMMANDS¶
help [COMMAND]
version
enable UUID
The command will not detect any errors from the extension itself, use the info command to confirm that the extension state is ENABLED.
If the extension is already enabled, the command will do nothing.
disable UUID
If the extension is not enabled, the command will do nothing.
reset UUID
The extension will be disabled in GNOME, but may be enabled by other sessions like GNOME Classic.
info UUID
show UUID
list [OPTION...]
Options
--system
--enabled
--disabled
--prefs
--updates
-d, --details
prefs UUID
create [OPTION...]
Options
--description=DESC
--uuid=UUID
--template=TEMPLATE
-i, --interactive
pack [OPTION...] [SOURCE-DIRECTORY]
The bundle will always include the required files extension.js and metadata.json, as well as the optional stylesheet.css and prefs.js if found. Each additional source that should be included must be specified with --extra-source.
If the extension includes one or more GSettings schemas, they can either be placed in a schemas/ folder to be picked up automatically, or be specified with --schema.
Similarily, translations are included automatically when they are located in a po/ folder, otherwise the --podir option can be used to point to the correct directory. If no gettext domain is provided on the command line, the value of the gettext-domain metadata field is used if it exists, and the extension UUID if not.
All files are searched in SOURCE-DIRECTORY if specified, or the current directory otherwise.
Options
--schema=SCHEMA
--podir=PODIR
--gettext-domain=DOMAIN
-f, --force
-o, --out-dir=DIRECTORY
install [OPTION...] PACK
The command unpacks the extension files and moves them to the expected location in the user’s $HOME, so that it will be loaded in the next session.
It is mainly intended for testing, not as a replacement for the extension website. As extensions have privileged access to the user’s session, it is advised to never load extensions from untrusted sources without carefully reviewing their content.
Options
uninstall UUID
EXIT STATUS¶
On success 0 is returned, a non-zero failure code otherwise.
BUGS¶
The tool is part of the gnome-shell project, and bugs should be reported in its issue tracker at https://gitlab.gnome.org/GNOME/gnome-shell/issues.
August 2018 | GNOME-EXTENSIONS-TOOL |