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
16
16
transports, or customizing log output. The sky is the limit for the
17
17
customization that can be done through plugins.
21
22
We keep our list of plugins on the http://bazaar-vcs.org/BzrPlugins page.
23
How to Install a plugin
24
=======================
24
How to install a plugin
25
-----------------------
25
27
Installing a plugin is very easy! One can either install a plugin
26
28
system-wide or on a per user basis. Both methods involve creating a
27
29
``plugins`` directory. Within this directory one can place plugins in
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
Listing the installed plugins
57
-----------------------------
59
To do this, use the plugins command like this::
63
The name, location and version of each plugin installed will be displayed.
68
Here is a sample of some of the more popular plugins:
72
If you wish to write your own plugins, it is not difficult to do.
73
See `Writing a plugin`_ in the appendices to get started.
added
removed
doc/en/user-guide/plugins.txt
