5
Information on how to use plugins in Bazaar.
4
.. Information on how to use plugins in Bazaar.
9
9
A plugin is an external component for Bazaar that is typically made by
10
10
third parties. A plugin is capable of augmenting Bazaar by adding new
11
11
functionality. A plugin can also change current Bazaar behavior by
12
replacing current functionality. Plugins often work as a way for
13
developers to test new features for Bazaar prior to inclusion in the
14
official codebase. Plugins can do a variety of things, including
15
overriding commands, adding new commands, providing additional network
16
transports, or customizing log output. The sky is the limit for the
17
customization that can be done through plugins.
12
replacing current functionality. Sample applications of plugins are:
16
* providing additional network transports
17
* customizing log output.
19
The sky is the limit for the customization that can be done through plugins.
20
In fact, plugins often work as a way for developers to test new features for
21
Bazaar prior to inclusion in the official codebase. Plugins are helpful
22
at feature retirement time as well, e.g. deprecated file formats may one
23
day be removed from the Bazaar core and be made available as a plugin instead.
25
Plugins are good for users, good for external developers and good for
21
31
We keep our list of plugins on the http://bazaar-vcs.org/BzrPlugins page.
23
How to Install a plugin
24
=======================
25
Installing a plugin is very easy! One can either install a plugin
26
system-wide or on a per user basis. Both methods involve creating a
27
``plugins`` directory. Within this directory one can place plugins in
28
subdirectories. For example, ``plugins/bzrtools/``.
30
Two locations are currently checked: the bzrlib/plugins directory
31
(typically found in ``/usr/lib/python2.4/site-packages/bzrlib/plugins/``) and
32
``$HOME/.bazaar/plugins/``.
34
One can additionally override the home plugins by setting the environment
35
variable ``BZR_PLUGIN_PATH`` to a directory that contains plugins. The
36
installation of a plugin can be checked by running ``bzr plugins`` at
37
any time. New commands can be seen by running ``bzr help commands``.
38
The commands provided by a plugin are shown followed by the name of the
33
How to install a plugin
34
-----------------------
36
Installing a plugin is very easy! If not already created, create a
37
``plugins`` directory under your Bazaar configuration directory
38
($BZR_HOME), i.e. ``~/.bazaar/`` on Linux and
39
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\``
40
on Windows. Within this directory, each plugin is placed in its own
41
43
Plugins work particularly well with Bazaar branches. For example, to
42
install the bzrtools plugins for your main user account, one can perform
44
install the bzrtools plugins for your main user account on Linux,
45
one can perform the following::
45
47
bzr branch http://panoramicfeedback.com/opensource/bzr/bzrtools
46
48
~/.bazaar/plugins/bzrtools
51
53
than installing ``bzr-gtk`` to ``~/.bazaar/plugins/bzr-gtk``, install it
52
54
to ``~/.bazaar/plugins/gtk``.
56
Plugins are very similar to bzr core functionality. They can import
57
anything in bzrlib. A plugin may simply override standard functionality,
58
but most plugins supply new commands.
60
To create a command, make a new object that derives from
61
``bzrlib.commands.Command``, and name it ``cmd_foo``, where foo is the name of
62
your command. If you create a command whose name contains an underscore,
63
it will appear in the UI with the underscore turned into a hyphen. For
64
example, `cmd_baz_import` will appear as `baz-import`. For examples of how
65
to write commands, please see ``builtins.py``.
67
Once you've created a command you must register the command with
68
``bzrlib.commands.register_command(cmd_foo)``. You must register the
69
command when your file is imported, otherwise bzr will not see it.
71
Bzr will scan ``bzrlib/plugins`` and ``~/.bazaar/plugins`` for plugins
72
by default. You can override this with ``BZR_PLUGIN_PATH``. Plugins
73
may be either modules or packages. If your plugin is a single file,
74
you can structure it as a module. If it has multiple files, or if you
75
want to distribute it as a bzr branch, you should structure it as a
76
package, i.e. a directory with an ``__init__.py`` file.
78
Please feel free to contribute your plugin to BzrTools, if you think it
79
would be useful to other people.
56
Alternative plugin locations
57
----------------------------
59
If you have the necessary permissions, plugins can also be installed on
60
a system-wide basis. Two locations are currently checked for plugins:
62
1. the system location - bzrlib/plugins
63
2. the personal location - $BZR_HOME/plugins.
65
On a Linux installation, these locations are typically
66
``/usr/lib/python2.4/site-packages/bzrlib/plugins/`` and
67
``$HOME/.bazaar/plugins/``.
68
On a Windows installation, the system location might be
69
``C:\\Program Files\\Bazaar\\plugins``
70
while the personal location might be
71
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\plugins``.
73
One can additionally override the personal plugins location
74
by setting the environment variable ``BZR_PLUGIN_PATH``
75
to a directory that contains plugins.
77
Listing the installed plugins
78
-----------------------------
80
To do this, use the plugins command like this::
84
The name, location and version of each plugin installed will be displayed.
86
New commands added by plugins can be seen by running ``bzr help commands``.
87
The commands provided by a plugin are shown followed by the name of the
93
Here is a sample of some of the more popular plugins.
95
================ ================= ==================================
96
Category Name Description
97
================ ================= ==================================
98
GUI QBzr Qt-based GUI tools
99
GUI bzr-gtk GTK-based GUI tools
100
GUI bzr-eclipse Eclipse integration
101
General bzrtools misc. enhancements including shelf
102
General difftools external diff tool helper
103
General extmerge external merge tool helper
104
Integration bzr-svn use Subversion as a repository
105
Migration cvsps migrate CVS patch-sets
106
================ ================= ==================================
108
If you wish to write your own plugins, it is not difficult to do.
109
See `Writing a plugin`_ in the appendices to get started.
added
removed
doc/en/user-guide/plugins.txt
