cinnamon-extension-tool

cinnamon-extension-tool TYPE COMMAND [ARGUMENT]

TYPE
    Specifies the type of Cinnamon component to manage. Possible values are: applet, desklet, extension, or theme.

COMMAND
    Specifies the action to perform on the chosen component type. Possible values are: install, remove, enable, disable, or list.

ARGUMENT
    This parameter is context-dependent based on the chosen COMMAND.

• For install: It expects the PATH_TO_ZIP file of the component (e.g., /home/user/my_extension.zip).
• For remove, enable, or disable: It expects the UUID (Unique User ID) of the installed component (e.g., example@extension.org).
• For list: No argument is required.

The cinnamon-extension-tool is a command-line utility designed for the Cinnamon desktop environment. It provides a convenient way for users and developers to interact with various Cinnamon components, including extensions, applets, desklets, and themes. This tool simplifies tasks such as installing new components from .zip files, removing existing ones, enabling or disabling installed items, and listing all available components of a specific type. It's particularly useful for scripting automation, troubleshooting, or for users who prefer command-line interaction over graphical interfaces for managing their Cinnamon environment. The tool ensures proper handling of component files and configurations within the Cinnamon ecosystem, providing a robust interface for system management.

This command is specific to the Cinnamon desktop environment.
Changes made, especially enabling or disabling components, may require restarting Cinnamon (e.g., by logging out and back in, or pressing Alt+F2 and typing r) for the changes to take full effect.
Component files are typically installed into ~/.local/share/cinnamon/{applets,desklets,extensions,themes}.

Here are some common examples of how to use the cinnamon-extension-tool:

List all installed extensions:
cinnamon-extension-tool extension list

Install a new desklet from a local zip file:
cinnamon-extension-tool desklet install /path/to/my_custom_desklet.zip

Enable a specific applet by its UUID:
cinnamon-extension-tool applet enable 'my_applet_uuid@example.com'

Remove a theme:
cinnamon-extension-tool theme remove 'MyThemeName'

The cinnamon-extension-tool was developed as an integral part of the Cinnamon desktop environment, which originated as a fork of GNOME Shell in 2011. Its creation aimed to provide a dedicated command-line interface for managing Cinnamon's unique components (applets, desklets, extensions, and themes), offering an alternative to graphical management tools. Over time, it has evolved alongside the Cinnamon desktop, maintaining compatibility and expanding its functionality to support the growing ecosystem of Cinnamon components, proving invaluable for both developers and users preferring command-line workflows.

cinnamon(1), dconf(1), gnome-shell-extension-tool(1)