Skip to main content

Tool for downloading/managing QGIS plugins from CLI.

Project description


Tests PyPi version badge PyPI - Downloads PyPI - Python Version

Mainly designed for QGIS Server plugins.

Not tested on Windows.

The CLI API is not stable yet.


Python 3.6 minimum, you can make a Python venv if needed.

python3 --version
pip3 install qgis-plugin-manager
python3 -m pip install qgis-plugin-manager

Environment variable

QGIS-Plugin-Manager will take care of following variables :

  • QGIS_PLUGIN_MANAGER_SOURCES_FILE for storing a path to the sources.list otherwise, the current folder will be used.
  • QGIS_PLUGIN_MANAGER_CACHE_DIR for storing all XML files downloaded otherwise, the current folder will be used .cache_qgis_plugin_manager
  • QGIS_PLUGIN_MANAGER_SKIP_SOURCES_FILE, boolean when we do not need a sources.list file, for instance to list plugins only
  • QGIS_PLUGINPATH for storing plugins
  • PYTHONPATH for importing QGIS libraries


Either you need to go in the directory where you are storing plugins, or you can use the environment variable QGIS_PLUGINPATH. You can read the documentation on QGIS Server about this variable.

cd /path/where/you/have/plugins
# usually
cd /usr/lib/qgis/plugins
$ qgis-plugin-manager --help
usage: qgis-plugin-manager [-h] [-v] {init,list,remote,update,upgrade,cache,search,install} ...

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         Print the version and exit (default: False)

  qgis-plugin-manager command

    init                Create the `sources.list` with as remote
    list                List all plugins in the directory
    remote              List all remote server
    update              Update all index files
    upgrade             Upgrade all plugins installed
    cache               Look for a plugin in the cache
    search              Search for plugins
    install             Install a plugin


To create the first sources.list in the directory with at least the default repository :

$ qgis-plugin-manager init
$ cat sources.list

You can have one or many servers, one on each line.


List all plugins installed :

$ qgis-plugin-manager list
QGIS server version 3.19.0
List all plugins in /home/etienne/dev/qgis/server_plugin

|  Name            |  Version  | Flags           |  QGIS min  |  QGIS max  |  Author         | Folder owner     | Action          |
|Lizmap            |master     |                 |3.4         |3.99        |3Liz             | root : 0o755     | Unkown version   |
|wfsOutputExtension|1.5.3      |Server           |3.0         |            |3Liz             | etienne : 0o755  |                  |
|QuickOSM          |1.14.0     |Processing       |3.4         |3.99        |Etienne Trimaille| etienne : 0o755  | Upgrade to 1.16.0|
|cadastre          |1.6.2      |Server,Processing|3.0         |3.99        |3liz             | www-data : 0o755 |                  |
|atlasprint        |3.2.2      |Server           |3.10        |            |3Liz             | www-data : 0o755 |                  |

Install needed plugins only, mainly on QGIS server

Important note, install only plugins you need you. On QGIS desktop, plugins can slow down your computer. On QGIS server, plugins are like hooks into QGIS server, they can alter input or output of QGIS server. They can produce unexpected result if you don't know how the plugin works. Please refer to their respective documentation or the application that needs QGIS server plugins (for instance, plugins for Lizmap Web Client)


$ qgis-plugin-manager remote
List of remotes :

$ cat sources.list[VERSION]

[VERSION] is a token in the sources.list file to be replaced by the QGIS version, for instance 3.22. If QGIS is upgraded, the XML file will be updated as well.

You don't have to set the TOKEN for all URL : is valid.


To fetch the XML files from each repository :

$ qgis-plugin-manager update
$ ls .cache_qgis_plugin_manager/


Check if a plugin is available :

$ qgis-plugin-manager cache atlasprint
Plugin atlasprint : v3.2.2 available


Look for plugins according to tags and title :

$ qgis-plugin-manager search dataviz
Data Plotly


Plugins are case-sensitive and might have spaces in its name :

$ qgis-plugin-manager install dataplotly
Plugin dataplotly latest not found.
Do you mean maybe 'Data Plotly' ?
$ qgis-plugin-manager install 'Data Plotly'

Install the latest version :

$ qgis-plugin-manager install QuickOSM
Installation QuickOSM latest

or a specific version :

$ qgis-plugin-manager install QuickOSM==1.14.0
Installation QuickOSM 1.14.0


Upgrade all plugins installed :

$ qgis-plugin-manager upgrade

Note, like APT, update is needed before to refresh the cache.

Run tests

export PYTHONPATH=/home/etienne/dev/app/qgis-master/share/qgis/python/:/usr/lib/python3/dist-packages/
cd test
python3 -m unittest


  • proper exit code
  • API
  • documentation

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qgis-plugin-manager-1.2.1.tar.gz (16.9 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page