Bazaar Plugins Guide

Introduction

• Installing a plugin
  • Listing the installed plugins
  • System-wide installation
  • Per-user installation
  • Testing a plugin
  • Getting help on a plugin
• Developing a plugin
  • Naming
  • Licensing
  • Registration
  • Testing
  • Providing help
  • Providing custom code via hooks
  • Defining a new command
  • Extending an existing command
  • GUI integration
  • Managing data
  • Useful metadata
  • Performance tips
  • Adding your plugin to the Plugins Guide
  • Learning more
  • Mini API Reference

See http://bazaar-vcs.org/BzrPlugins for the complete plugin registry.

Documentation on plugins commonly used by Bazaar projects is given below.

Web

• launchpad - Integration with Launchpad.net (project hosting service)
• loggerhead - Web interface for browsing branches
• webdav - Support writing to WebDAV branches
• xmloutput - XML interface for external tool integration

Desktop

• explorer - Desktop application for GNOME, KDE, Windows and OS X
• extmerge - Merge using external GUI tools
• difftools - Show differences using external GUI tools
• gtk - GTK dialogs for many Bazaar commands
• qbzr - Qt dialogs for many Bazaar commands
• vimdiff - Show differences using vimdiff

Publishing

• automirror - Automatically update a remote working tree upon commit
• keywords - Keyword templating (e.g. Date, Authors, etc.)
• push-and-update - Keep a remote working tree up to date
• repo-push - Push a repository and its branches to a remote location
• upload - Upload a working tree with incremental updates

Change notification

• cia - Submit commits to CIA (open source VCS informant)
• email - Send email upon commit

Change control

• checkeol - Pre-commit hook to check files for correct line-endings
• pqm - Submit changes to a Patch Queue Manager
• testrunner - Run a command before allowing a commit
• text-checker - Avoid committing undesired text like trailing white space

Change ordering

• loom - Manage a stack of patches over an upstream
• pipeline - Work on large changes as smaller pieces
• rewrite - Rewrite history by replaying patches
• undelete - Undelete to last known version of files/dirs

Metaprojects

• builder - Construct a branch from a recipe
• externals - External branches ala Subversion
• scmproj - Organize branches into a unified project
• merge-into - Make it easier to merge another project into this one

History exploration

• bisect - Find the revision introducing a bug using a binary search
• diffstat - Show diff statistics for a revision or patch
• search - Full text index and search of a repository
• stats - Generate history statistics like authors or commits over time

Productivity

• automv - Automatically detect renames/moves in the working tree
• bookmarks - Bookmarking system for often used branch locations/URLs
• bzrtools - Collection of various useful commands
• colo - Work with colocated branches using current technology
• custom-url-schemes - Simplify references to branches at long URLs
• debuntu - Shortcuts to Ubuntu and Debian source branches on Launchpad
• grep - Grep through files known to bzr

Foreign branches

• git - Transparent interoperability with Git branches
• hg - Read-only support for Mercurial branches
• svn - Transparent interoperability with Subversion branches

Migration

• bazimport - Import an Arch or Baz archive
• cvsps-import - Import CVS branches using cvsps to extract patchsets
• fastimport - Import/export of history via fast-import format

Performance tuning

• dns-cache - Cache DNS requests, greatly speeding up urllib.urlopen requests
• historycache - Faster lookup of dotted revision numbers and history graphs
• service - Keep bzrlib loaded in memory to decrease command startup time

Diagnostics

• ping - Ping a smart server and report the response
• repodetails - Analyze repository storage and report results

Windows specific

• autoflush - Cygwin stdio compatibility for Windows Bazaar
• docdiff - Show differences for Office (e.g. Word, Excel) documents
• x-bit - Control x-bit inside of bzr inventory

Linux/UNIX specific

• builddeb - Build Debian packages from Bazaar branches
• dbus - D-Bus integration and optional local-LAN commit broadcasting
• pager - Pipe commands producing long output to a pager (e.g. less)

Binary file support

• oodiff - Show text diffs of OpenOffice.org documents