Installing a plugin

Listing the installed plugins

Some plugins are bundled with the all-in-one installer for Windows or Mac OS X. To view the plugins already installed, follow the instructions below.

From within Bazaar Explorer 0.10.0 or later:

Bazzar ‣ Plugins

From within Bazaar Explorer 0.9.0 or earlier:

Tools ‣ Plugins

From the command line:

bzr plugins

System-wide installation

Some plugins come pre-packaged, particularly when they have third-party dependencies (such as C libraries). Try the package manager on your operating system or look for a custom installer on Windows.

Per-user installation

In many cases, it’s fine to install a plugin by hand into your personal plugins area:

  • $HOME/.bazaar/plugins/ on GNU/Linux and OS X
  • $APPDATA/bazaar/2.0/plugins on Windows.


You can override this location by setting the environment variable BZR_PLUGIN_PATH to a directory that contains plugins.

The general recipe is:

cd <plugins-area>
bzr branch lp:bzr-xxx-yyy xxx_yyy

If the plugin isn’t hosted on Launchpad, provide the full branch location given in the registry for that plugin.

In some cases, you may also need to run

python build_ext -i

This compiles C extensions, builds man pages and executes whatever other magic is appropriate for the plugin to be correctly installed.

Testing a plugin

If a plugin provided tests, you can typically run those tests using:

bzr selftest xxx


This actually finds all tests including xxx in their name. If the above command runs more tests than you expected, try:

bzr selftest

Getting help on a plugin

All plugins should provide basic help. The command to view the help for plugin xxx is:

bzr help xxx

If xxx is a command name, you’ll need to be more explicit to get the top level help:

bzr help plugin/xxx

Help for many popular plugins is available on the web in the Plugins Guide,

Table Of Contents

Previous topic

Bazaar Plugins Guide

Next topic

Developing a plugin

This Page