brz(1)

📦

version 3.3.22 · 11 versions

💖 brz — Breezy 💖

Welcome to the brz(1) manual page, bestie. The manual name is brz, and the vibe is next-generation distributed version control. Buckle up. ✨

✨ NAME ✨

brz — Breezy next-generation distributed version control. Periodt. 💅

✨ SYNOPSIS ✨

brz command [ command_options ]
brz help
brz help command

✨ DESCRIPTION ✨

Breezy (or brz) is a distributed version control system that is powerful, friendly, and scalable. Breezy is a fork of the Bazaar version control system. No cap. 🦋

Breezy keeps track of changes to software source code (or similar information); lets you explore who changed it, when, and why; merges concurrent changes; and helps people work together in a team. It’s giving teamwork, but make it version control. 💖

✨ COMMAND OVERVIEW ✨

Here’s the whole clique of commands. Each one is literally a brz subcommand. 👑

brz add [FILE...] — adds specified files or directories.
brz alias [NAME] — sets, unsets, and displays aliases.
brz annotate FILENAME — shows the origin of each line in a file.
brz bind [LOCATION] — converts the current branch into a checkout of the supplied branch.
brz bisect SUBCOMMAND [ARGS...] — finds an interesting commit using a binary search.
brz branch FROM_LOCATION [TO_LOCATION] — creates a new branch that is a copy of an existing branch.
brz branches [LOCATION] — lists the branches available at the current location.
brz break-lock [LOCATION] — breaks a dead lock.
brz cat FILENAME — writes the contents of a file as of a given revision to standard output.
brz check [PATH] — validates working tree structure, branch consistency, and repository history.
brz checkout [BRANCH_LOCATION] [TO_LOCATION] — creates a new checkout of an existing branch.
brz clean-tree — removes unwanted files from the working tree.
brz clone FROM_LOCATION [TO_LOCATION] — clones a control directory.
brz commit [SELECTED...] — commits changes into a new revision.
brz config [NAME] — displays, sets, or removes a configuration option.
brz conflicts — lists files with conflicts.
brz cp [NAMES...] — copies a file.
brz deleted — lists files deleted in the working tree.
brz diff [FILE...] — shows differences in the working tree, between revisions, or between branches.
brz export DEST [BRANCH_OR_SUBDIR] — exports current or past revision to a destination directory or archive.
brz grep PATTERN [PATH...] — prints lines matching PATTERN for specified files and revisions.
brz help [TOPIC] — shows help on a command or other topic.
brz ignore [NAME_PATTERN...] — ignores specified files or patterns.
brz ignored — lists ignored files and the patterns that matched them.
brz import SOURCE [TREE] — imports sources from a directory, tarball, or zip file.
brz info [LOCATION] — shows information about a working tree, branch, or repository.
brz init [LOCATION] — makes a directory into a versioned branch.
brz init-shared-repository LOCATION — creates a shared repository for branches to share storage space.
brz join TREE — combines a tree into its containing tree.
brz launchpad-login [NAME] — shows or sets the Launchpad user ID.
brz launchpad-logout — unsets the Launchpad user ID.
brz launchpad-open [LOCATION] — opens a Launchpad branch page in your web browser.
brz link-tree LOCATION — hardlinks matching files to another tree.
brz log [FILE...] — shows historical log for a branch or subset of a branch.
brz lp-find-proposal — finds the proposal to merge this revision.
brz ls [PATH] — lists files in a tree.
brz merge [LOCATION] — performs a three-way merge.
brz missing [OTHER_BRANCH] — shows unmerged/unpulled revisions between two branches.
brz mkdir DIR... — creates a new versioned directory.
brz mv [NAMES...] — moves or renames a file.
brz nick [NICKNAME] — prints or sets the branch nickname.
brz pack [BRANCH_OR_REPO] — compresses the data within a repository.
brz patch [FILENAME] — applies a named patch to the current tree.
brz ping LOCATION — pings a Bazaar smart server.
brz plugins — lists the installed plugins.
brz pull [LOCATION] — turns this branch into a mirror of another branch.
brz push [LOCATION] — updates a mirror of this branch.
brz reconcile [BRANCH] — reconciles brz metadata in a branch.
brz reconfigure [LOCATION] — reconfigures the type of a brz directory.
brz remerge [FILE...] — redoes a merge.
brz remove [FILE...] — removes files or directories.
brz remove-branch [LOCATION] — removes a branch.
brz remove-tree [LOCATION...] — removes the working tree from a given branch/checkout.
brz renames [DIR] — shows a list of renamed files.
brz resolve [FILE...] — marks a conflict as resolved.
brz revert [FILE...] — sets files in the working tree back to the contents of a previous revision.
brz revno [LOCATION] — shows current revision number.
brz root [FILENAME] — shows the tree root directory.
brz send [SUBMIT_BRANCH] [PUBLIC_BRANCH] — mails or creates a merge-directive for submitting changes.
brz serve — runs the brz server.
brz shelve [FILE...] — temporarily sets aside some changes from the current tree.
brz sign-my-commits [LOCATION] [COMMITTER] — signs all commits by a given committer.
brz split TREE — splits a subdirectory of a tree into a separate tree.
brz status [FILE...] — displays status summary.
brz switch [TO_LOCATION] — sets the branch of a checkout and updates.
brz tag [TAG_NAME] — creates, removes, or modifies a tag naming a revision.
brz tags — lists tags.
brz testament [BRANCH] — shows testament (signing-form) of a revision.
brz unbind — converts the current checkout into a regular branch.
brz uncommit [LOCATION] — removes the last committed revision.
brz unshelve [SHELF_ID] — restores shelved changes.
brz update [DIR] — updates a working tree to a new revision.
brz upgrade [URL] — upgrades a repository, branch, or working tree to a newer format.
brz verify-signatures [LOCATION] — verifies all commit signatures.
brz version — shows version of brz.
brz version-info [LOCATION] — shows version information about this tree.
brz view [FILE...] — manages filtered views.
brz whoami [NAME] — shows or sets brz user id.

✨ COMMAND REFERENCE ✨

Bestie, this is the deep dive. 👇

💖 `brz --help`

Alias for help, see brz help.

💖 `brz -?`

Alias for help, see brz help.

💖 `brz -h`

Alias for help, see brz help.

💖 `brz ?`

Alias for help, see brz help.

🌸 `brz add [FILE...]`

Options

--dry-run — Show what would be done, but don’t actually do anything. It’s the window-shopping of file adding. 🛍️
--file-ids-from ARG — Lookup file ids from this tree.
--help, -h — Show help message.
--no-recurse, -N — Don’t recursively add the contents of directories.
--quiet, -q — Only display errors and warnings.
--usage — Show usage message and options.
--verbose, -v — Display more information.

See also: ignore, remove

Add specified files or directories. 💅

In non-recursive mode, all the named items are added, regardless of whether they were previously ignored. A warning is given if any of the named files are already versioned. Lowkey important.

In recursive mode (the default), files are treated the same way but the behaviour for directories is different. Directories that are already versioned do not give a warning. All directories, whether already versioned or not, are searched for files or subdirectories that are neither versioned or ignored, and these are added. This search proceeds recursively into versioned directories. If no names are given . is assumed. That’s a literal dot, bestie.

A warning will be printed when nested trees are encountered, unless they are explicitly ignored.

Therefore simply saying brz add will version all files that are currently unknown. Main character energy, honestly. ✨

Adding a file whose parent directory is not versioned will implicitly add the parent, and so on up to the root. This means you should never need to explicitly add a directory, they’ll just get added when you add a file in the directory. No extra steps. Periodt.

--dry-run will show which files would be added, but not actually add them.

--file-ids-from will try to use the file ids from the supplied path. It looks up ids trying to find a matching parent directory with the same filename, and then by pure path. This option is rarely needed but can be useful when adding the same logical file into two branches that will be merged later (without showing the two different adds as a conflict). It is also useful when merging another project into a subdirectory of this one.

Any files matching patterns in the ignore list will not be added unless they are explicitly mentioned.

In recursive mode, files larger than the configuration option add.maximum_file_size will be skipped. Named items are never skipped due to file size.

🌸 `brz alias [NAME]`

Options

--help, -h — Show help message.
--quiet, -q — Only display errors and warnings.
--remove — Remove the alias.
--usage — Show usage message and options.
--verbose, -v — Display more information.

Set/unset and display aliases.

Examples:

Show the current aliases:

brz alias

Show the alias specified for 'll':

brz alias ll

Set an alias for 'll':

brz alias ll="log --line -r-10..-1"

To remove an alias for 'll':

brz alias --remove ll

🌸 `brz ann`

Alias for annotate, see brz annotate.

🌸 `brz annotate FILENAME`

Options

--all — Show annotations on all lines.
--directory ARG, -d — Branch to operate on, instead of working directory.
--help, -h — Show help message.
--long — Show commit date in annotations.
--quiet, -q — Only display errors and warnings.
--revision ARG, -r — See help revisionspec for details.
--show-ids — Show internal object ids.
--usage — Show usage message and options.
--verbose, -v — Display more information.

Aliases: ann, blame, praise

Show the origin of each line in a file. 💅

This prints out the given file with an annotation on the left side showing which revision, author and date introduced the change. So basically: who touched this line, when, and in what commit. 💅

If the origin is the same for a run of consecutive lines, it's only shown at the top, unless the --all option is given. So like, the boring repeated stuff gets collapsed unless you beg for the full thing. 🫶

🌸 `brz bind [LOCATION]`

Options:

--directory ARG, -d — Branch to operate on, instead of working directory.
--help, -h — Show help message.
--quiet, -q — Only display errors and warnings.
--usage — Show usage message and options.
--verbose, -v — Display more information.

See also: checkouts, unbind

Convert the current branch into a checkout of the supplied branch. If no branch is supplied, rebind to the last bound location. It's giving "glow up your branch into a checkout" energy. ✨

Once converted into a checkout, commits must succeed on the master branch before they will be applied to the local branch. No sneaky solo commits, bestie — master goes first, periodt. 😭

Bound branches use the nickname of its master branch unless it is set locally, in which case binding will update the local nickname to be that of the master. 👑

🦋 `brz bisect SUBCOMMAND [ARGS...]`

Options:

--directory ARG, -d — Branch to operate on, instead of working directory.
--help, -h — Show help message.
--output ARG, -o — Write log to this file.
--quiet, -q — Only display errors and warnings.
--revision ARG, -r — See help revisionspec for details.
--usage — Show usage message and options.
--verbose, -v — Display more information.

Find an interesting commit using a binary search. 🔍

Bisecting, in a nutshell, is a way to find the commit at which some testable change was made, such as the introduction of a bug or feature. By identifying a version which did not have the interesting change and a later version which did, a developer can test for the presence of the change at various points in the history, eventually ending up at the precise commit when the change was first introduced. So you're basically playing hot-and-cold with git history until you pin down the exact commit that did the thing. 🔥

This command uses subcommands to implement the search, each of which changes the state of the bisection. The subcommands are:

brz bisect start
- Start a bisect, possibly clearing out a previous bisect. 🧹
brz bisect yes [-r rev]
- The specified revision (or the current revision, if not given) has the characteristic we're looking for. ✅
brz bisect no [-r rev]
- The specified revision (or the current revision, if not given) does not have the characteristic we're looking for. ❌
brz bisect move -r rev
- Switch to a different revision manually. Use if the bisect algorithm chooses a revision that is not suitable. Try to move as little as possible. 🚶‍♀️
brz bisect reset
- Clear out a bisection in progress. 🌪️
brz bisect log [-o file]
- Output a log of the current bisection to standard output, or to the specified file. 📝
brz bisect replay <logfile>
- Replay a previously-saved bisect log, forgetting any bisection that might be in progress. 🔁
brz bisect run <script>
- Bisect automatically using <script> to determine 'yes' or 'no'. <script> should exit with:
  - 0 for yes
  - 125 for unknown (like build failed so we could not test)
  - anything else for no

🎀 `brz blame`

Alias for annotate, see brz annotate. Same energy, different name — the way it just reuses the whole vibe. 💜

🌈 `brz branch FROM_LOCATION [TO_LOCATION]`

Options:

--bind — Bind new branch to from location.
--colocated-branch ARG, -b — Name of colocated branch to sprout.
--files-from ARG — Get file contents from this tree.
--hardlink — Hard-link working tree files where possible.
--help, -h — Show help message.
--no-recurse-nested — Do not recursively check out nested trees.
--no-tree — Create a branch without a working-tree.
--quiet, -q — Only display errors and warnings.
--revision ARG, -r — See help revisionspec for details.
--stacked — Create a stacked branch referring to the source branch. The new branch will depend on the availability of the source branch for all operations.
--standalone — Do not use a shared repository, even if available.
--switch — Switch the checkout in the current directory to the new branch.
--usage — Show usage message and options.
--use-existing-dir — By default branch will fail if the target directory exists, but does not already have a control directory. This flag will allow branch to proceed.
--verbose, -v — Display more information.

See also: checkout

Create a new branch that is a copy of an existing branch. 🍓

If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will be used. In other words, branch ../foo/bar will attempt to create ./bar. If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION is derived from the FROM_LOCATION by stripping a leading scheme or drive identifier, if any. For example, branch lp:foo-bar will attempt to create ./foo-bar. It just vibes off the name, fr fr. ✨

To retrieve the branch as of a particular revision, supply the --revision parameter, as in branch foo/bar -r 5.

💖 `brz branches [LOCATION]`

Options:

--help, -h — Show help message.
--quiet, -q — Only display errors and warnings.
--recursive, -R — Recursively scan for branches rather than just looking in the specified location.
--usage — Show usage message and options.
--verbose, -v — Display more information.

List the branches available at the current location. 👀

This command will print the names of all the branches at the current location. Simple, clean, iconic. 💅

🔥 `brz break-lock [LOCATION]`

Options:

--config — LOCATION is the directory where the config lock is.
--force — Do not ask for confirmation before breaking the lock.
--help, -h — Show help message.
--quiet, -q — Only display errors and warnings.
--usage — Show usage message and options.
--verbose, -v — Display more information.

Break a dead lock. 🔓

This command breaks a lock on a repository, branch, working directory or config file.

CAUTION: Locks should only be broken when you are sure that the process holding the lock has been stopped. Like, be SO sure. If that process is still alive you're about to cause problems. 💀

You can get information on what locks are open via the brz info [location] command. 🕵️‍♀️

Examples:

brz break-lock
brz break-lock brz+ssh://example.com/brz/foo
brz break-lock --conf ~/.config/breezy

🧚 `brz cat FILENAME`

Options:

--directory ARG, -d — Branch to operate on, instead of working directory.
--filters — Apply content filters to display the convenience form.
--help, -h — Show help message.
--name-from-revision — The path name in the old tree.
--quiet, -q — Only display errors and warnings.
--revision ARG, -r — See help revisionspec for details.
--usage — Show usage message and options.
--verbose, -v — Display more information.

See also: ls

Write the contents of a file as of a given revision to standard output. 📤

If no revision is nominated, the last revision is used.

Note: Take care to redirect standard output when using this command on a binary file. Do NOT just dump binary into your terminal, bestie, your scrollback will never recover. 😭

⭐ `brz check [PATH]`

Options:

--branch — Check the branch related to the current directory.
--help, -h — Show help message.
--quiet, -q — Only display errors and warnings.
--repo — Check the repository related to the current directory.
--tree — Check the working tree related to the current directory.
--usage — Show usage message and options.
--verbose, -v — Display more information.

See also: reconcile

Validate working tree structure, branch consistency and repository history. Vibe check for your data. ✨

This command checks various invariants about branch and repository storage to detect data corruption or brz bugs.

The working tree and branch checks will only give output if a problem is detected. The output fields of the repository check are:

revisions — This is just the number of revisions checked. It doesn't indicate a problem.
versionedfiles — This is just the number of versionedfiles checked. It doesn't indicate a problem.
unreferenced ancestors — Texts that are ancestors of other texts, but are not properly referenced by the revision ancestry. This is a subtle problem that Breezy can work around.
unique file texts — This is the total number of unique file contents seen in the checked revisions. It does not indicate a problem.
repeated file texts — This is the total number of repeated texts seen in the checked revisions. Texts can be repeated when their file entries are modified, but the file contents are not. It does not indicate a problem.

If no restrictions are specified, all data that is found at the given location will be checked.

Examples:

Check the tree and branch at foo:

brz check --tree --branch foo

Check only the repository at bar:

brz check --repo bar

Check everything at baz:

brz check baz

👑 `brz checkin`

Alias for commit, see brz commit. 💜

`brz checkout [BRANCH_LOCATION] [TO_LOCATION]` 🎀

Options:

--files-from ARG — grab the file contents from this tree instead, bestie.
--hardlink — hard-link the working tree files wherever it's possible to do that. ✨
--help, -h — show the help message. classic.
--lightweight — do a lightweight checkout. Lightweight checkouts stay dependent on having access to the branch for every single operation 😭. Normal checkouts can do normal stuff like diff and status without that access, and they also support local commits. so like, pick wisely.
--quiet, -q — only display errors and warnings. silent mode. 🤫
--revision ARG, -r — check help revisionspec for the deets.
--usage — show the usage message and the options.
--verbose, -v — display more information. give me everything.

Alias: co

See also: branch, checkouts, remove-tree, working-trees

Create a new checkout of an existing branch. 💅

If you leave out BRANCH_LOCATION, checkout will reconstitute a working tree for the branch it finds in .. So this is your moment if you deleted the working tree, or if it literally never got created in the first place — ie. if you pushed the branch to where it lives now using SFTP. 🌸

If you leave out TO_LOCATION, the last component of BRANCH_LOCATION gets used instead. Translation: checkout ../foo/bar will attempt to create ./bar. And if BRANCH_LOCATION has no / or path separator embedded in it, then TO_LOCATION is derived from BRANCH_LOCATION by stripping off a leading scheme or drive identifier, if there is one. Example: checkout lp:foo-bar will attempt to create ./foo-bar. 🦋

Wanna retrieve the branch as of a particular revision? Pass the --revision parameter, like this: checkout foo/bar -r 5. Heads up though, that's gonna be immediately out of date — [so you cannot commit] — but it may still be useful (ie. to examine old code. 👀)

`brz ci` 🌈

Alias for commit, see brz commit.

`brz clean-tree` 🧹

Options:

--detritus — delete conflict files, merge and revert backups, and failed selftest dirs.
--directory ARG, -d — branch to operate on, instead of the working directory.
--dry-run — show the files it would delete instead of actually deleting them. peek first, bestie 💖
--force — do not prompt before deleting. no take-backs.
--help, -h — show help message.
--ignored — delete all ignored files.
--quiet, -q — only display errors and warnings.
--unknown — delete files unknown to brz (this is the default).
--usage — show usage message and options.
--verbose, -v — display more information.

Remove unwanted files from working tree. 🗑️

By default, only unknown files get deleted — not ignored ones. And versioned files? Never deleted. Periodt.

There's another class called 'detritus', which includes files emitted by brz during normal operations and selftests. (The value of these files decreases with time. it's giving expiry date 🍓)

If no options are specified, unknown files are deleted. Otherwise, the option flags are respected, and they may be combined.

To check what clean-tree is about to do, use --dry-run. 👑

`brz clone FROM_LOCATION [TO_LOCATION]` 👯

Options:

--help, -h — show help message.
--no-recurse-nested — do not recursively check out nested trees.
--quiet, -q — only display errors and warnings.
--revision ARG, -r — see help revisionspec for details.
--usage — show usage message and options.
--verbose, -v — display more information.

Clone a control directory.

`brz co` 💫

Alias for checkout, see brz checkout.

`brz commit [SELECTED...]` 🔥

Options:

--author ARG — set the author's name, if it's different from the committer.
--bugs ARG — link to a related bug. (see brz help bugs).
--commit-time ARG — manually set a commit time using commit date format, eg. '2009-10-10 08:00:00 +0100'.
--exclude ARG, -x — do not consider changes made to a given path.
--file MSGFILE, -F — take commit message from this file.
--fixes ARG — mark a bug as being fixed by this revision (see brz help bugs).
--help, -h — show help message.
--local — perform a local commit in a bound branch. Local commits are not pushed to the master branch until a normal commit is performed.
--lossy — when committing to a foreign version control system, do not push data that can not be natively represented.
--message ARG, -m — description of the new revision.
--quiet, -q — only display errors and warnings.
--show-diff, -p — when no message is supplied, show the diff along with the status summary in the message editor.
--strict — refuse to commit if there are unknown files in the working tree.
--unchanged — commit even if nothing has changed.
--usage — show usage message and options.
--verbose, -v — display more information.

Aliases: ci, checkin

See also: add, bugs, hooks, uncommit

Commit changes into a new revision. 🌟

Every commit needs an explanatory message, okay? Usually you do that with the --message option (message straight from the command line) or with the --file option (message from a file). If you give neither of those, an editor pops open and you type the message yourself. And if you wanna see the changed files in the boilerplate text that loads into the editor, use the --show-diff option. 🎀

By default, the whole entire tree gets committed, and whoever's doing the committing is assumed to be the author. But you can override those defaults, and here's exactly how:

Selective commits:

If you specify selected files, only changes to those files get committed. And if you specify a directory, then that directory and literally everything inside it gets committed.

When excludes are given, they take precedence over selected files. Say you wanna commit only the changes within foo, but not the changes within foo/bar:

brz commit foo -x foo/bar

A selective commit after a merge is not yet supported. 🙈

Custom authors:

If the author of the change is not the same person as the committer, you can specify the author's name using the --author option. The name should be in the same format as a committer-id, eg. "John Doe <jdoe@example.com>". And if there's more than one author of the change, you can specify the option multiple times — once for each author. 👑

Checks:

A super common mistake is forgetting to add a new file or directory before running the commit command. The --strict option checks for unknown files and aborts the commit if any turn up. More advanced pre-commit checks can be implemented by defining hooks. See brz help hooks for details.

Things to note:

If you accidentally commit the wrong changes, or you make a spelling mistake in the commit message, say — you can use the uncommit command to undo it. See brz help uncommit for details. 💖

Hooks can also be configured to run after a commit. That lets you trigger updates to external systems like bug trackers. And the --fixes option can be used to record the association between a revision and one or more bugs. See brz help bugs for details. ✨

`brz config [NAME]` ⚙️

Options:

--all — display all the defined values for the matching options.
--directory ARG, -d — branch to operate on, instead of the working directory.
--help, -h — show help message.
--quiet, -q — only display errors and warnings.
--remove — remove the option from the configuration file.
--scope ARG — reduce the scope to the specified configuration file.
--usage — show usage message and options.
--verbose, -v — display more information.

See also: configuration

Display, set or remove a configuration option. 🌸

Displays the active value for the option NAME.

If --all is specified, NAME is interpreted as a regular expression and all matching options are displayed mentioning their scope and without resolving option references in the value). The active value that bzr will take into account is the first one displayed for each option. 👀

If NAME isn't given, --all .* is implied (all options are displayed for the current scope).

Setting a value is achieved by using NAME=value without spaces. The value is set in the most relevant scope and can be checked by displaying the option again. 🦋

Removing a value is achieved by using --remove NAME.

`brz conflicts` 💥

Options:

--directory ARG, -d — branch to operate on, instead of the working directory.
--help, -h — show help message.
--quiet, -q — only display errors and warnings.
--text — list paths of files with text conflicts.
--usage — show usage message and options.
--verbose, -v — display more information.

See also: conflict-types, resolve

List files with conflicts. 😭

Merge will do its absolute best to combine the changes in two branches, but there are some kinds of problems that only a human can fix. When it runs into those, it will mark a conflict. And a conflict means you need to fix something before you can commit. no pressure bestie.

Conflicts normally get listed as short, human-readable messages. But if --text is supplied, the pathnames of files with text conflicts are listed instead. (This is useful for editing all files with text conflicts. handy!)

Use brz resolve when you have fixed a problem. 🫶

`brz copy` 📋

Alias for cp, see brz cp.

brz cp</p> [NAMES...] 🫶

✨ Options

--help, -h — show the help message, bestie.
--quiet, -q — only show errors and warnings. shhh 🤫
--usage — show the usage message and the options.
--verbose, -v — show more info, spill the tea ☕

✨ Alias

copy 💖

✨ What it does

copy a file, that's it, that's the whole vibe.

✨ Usage

brz cp OLDNAME NEWNAME

brz cp SOURCE... DESTINATION

Soooo if the last argument is a versioned directory, all the other names get copied into it, periodt. Otherwise there's gotta be exactly two arguments and the file gets copied to a new name. no exceptions fr.

🚩 Files cannot be copied between branches. and only files can be copied right now, that's just where we're at. lowkey iconic limitation.

brz del</p> 💀

it's just an alias for "remove", go see brz remove. bye 🫶

brz deleted</p> 👻

✨ Options

--directory ARG, -d — branch to operate on, instead of the working directory.
--help, -h — show the help message.
--quiet, -q — only display errors and warnings.
--show-ids — show internal object ids (the little secret identifiers, iykyk).
--usage — show usage message and options.
--verbose, -v — display more information.

✨ See also

ls, status

✨ What it does

list the files that got deleted in the working tree 🪦

brz di</p> 💅

alias for "diff", see brz diff.

brz dif</p> 💅

alias for "diff", see brz diff. (yes there are two aliases, we love options 💖)

brz diff</p> [FILE...] 🌈

✨ Options

--change ARG, -c — select the changes introduced by the specified revision. see also help revisionspec.
--check-style — warn if trailing whitespace or spurious changes have been added 👀
--color ARG — color mode to use. always: always colorize output (this is the default). auto: only colorize if the terminal supports it and STDOUT is a TTY. never: never colorize. periodt.
--context ARG — how many lines of context to show.
--diff-options ARG — pass these options to the external diff program.
--format ARG, -F — which diff format to use.
--help, -h — show help message.
--new ARG — branch/tree to compare to.
--old ARG — branch/tree to compare from.
--prefix ARG, -p — set the prefixes added to old and new filenames, as two values separated by a colon. (eg "old/:new/").
--quiet, -q — only display errors and warnings.
--revision ARG, -r — see help revisionspec for details.
--usage — show usage message and options.
--using ARG — use this command to compare files.
--verbose, -v — display more information.

✨ Aliases

di, dif

✨ See also

status

✨ What it does

show differences in the working tree, between revisions or between branches ✨

If you give it no arguments at all, it lists all the changes for the current tree. If you give it files, it only lists the changes in those files. You can compare remote and multiple branches by using the --old and --new options. If you don't provide them, the default for both comes from the first argument (if there is one), or from the current tree if you gave no arguments at all.

brz diff -p1 is literally equivalent to brz diff --prefix old/:new/, and it produces patches suitable for patch -p1. slay.

⚠️ okay important one bestie — when you use the -r argument with a range of revisions, the differences are computed between the two specified revisions. That means the command does not show the changes introduced by the first revision in the range. This is different from how brz log interprets revision ranges, which does include the first revision in the range. don't get got 💀

✨ Exit values

1 - changed
2 - unrepresentable changes
3 - error
0 - no change

✨ Examples

Shows the difference in the working tree versus the last commit:

brz diff

Difference between the working tree and revision 1:

brz diff -r1

Difference between revision 3 and revision 1:

brz diff -r1..3

Difference between revision 3 and revision 1 for branch xxx:

brz diff -r1..3 xxx

The changes introduced by revision 2 (equivalent to -r1..2):

brz diff -c2

To see the changes introduced by revision X:

brz diff -cX

Note that in the case of a merge, the -c option shows the changes compared to the left hand parent. To see the changes against another parent, use:

brz diff -r<chosen_parent>..X

The changes between the current revision and the previous revision (equivalent to -c-1 and -r-2..-1)

brz diff -r-2..

Show just the differences for file NEWS:

brz diff NEWS

Show the differences in working tree xxx for file NEWS:

brz diff xxx/NEWS

Show the differences from branch xxx to this working tree:

brz diff --old xxx

Show the differences between two branches for file NEWS:

brz diff --old xxx --new yyy NEWS

Same as brz diff but prefix paths with old/ and new/:

brz diff --prefix old/:new/

Show the differences using a custom diff program with options:

brz diff --using /usr/bin/diff --diff-options -wu

brz export</p> DEST [BRANCH_OR_SUBDIR] 🎀

✨ Options

--directory ARG, -d — branch to operate on, instead of the working directory.
--filters — apply content filters to export the convenient form.
--format ARG — type of file to export to.
--help, -h — show help message.
--per-file-timestamps — set the modification time of files to that of the last revision in which it was changed.
--quiet, -q — only display errors and warnings.
--recurse-nested — include contents of nested trees.
--revision ARG, -r — see help revisionspec for details.
--root ARG — name of the root directory inside the exported file.
--uncommitted — export the working tree contents rather than that of the last revision.
--usage — show usage message and options.
--verbose, -v — display more information.

✨ What it does

export the current or a past revision to a destination directory or archive 📦

If you don't specify a revision, it exports the last committed revision. cool cool cool.

The format can be an "exporter" name, like tar, tgz, tbz2. If you don't give one, it tries to figure out the format from the extension. If there's no extension found, it exports to a directory (same as --format=dir).

If root is supplied, it gets used as the root directory inside container formats (tar, zip, etc). If you don't supply it, it defaults to the exported filename. The root option does nothing for the dir format, fyi.

If branch is omitted, then the branch containing the current working directory gets used.

🚩 Note: exporting a tree with non-ASCII filenames to zip is not supported. tragic, but real.

=================       =========================
Supported formats       Autodetected by extension
=================       =========================
   dir                         (none)
   tar                          .tar
   tbz2                    .tar.bz2, .tbz2
   tgz                      .tar.gz, .tgz
   zip                          .zip
=================       =========================

brz grep</p> PATTERN [PATH...] 🔍

✨ Options

--color WHEN — show match in color. WHEN is never, always or auto.
--diff, -p — grep for pattern in the changeset for each revision.
--exclude GLOB, -X — skip files whose base name matches GLOB.
--files-with-matches, -l — print only the name of each input file in which PATTERN is found.
--files-without-match, -L — print only the name of each input file in which PATTERN is not found.
--fixed-string, -F — interpret PATTERN as a single fixed string (not a regex).
--from-root — search for pattern starting from the root of the branch. (this implies --recursive)
--help, -h — show help message.
--ignore-case, -i — ignore case distinctions while matching.
--include GLOB, -I — search only files whose base name matches GLOB.
--levels N — number of levels to display — 0 for all, 1 for collapsed (1 is the default).
--line-number, -n — show 1-based line number.
--no-recursive — don't recurse into subdirectories. (the default is --recursive)
--null, -Z — write an ASCII NUL (\0) separator between output lines rather than a newline.
--quiet, -q — only display errors and warnings.
--revision ARG, -r — see help revisionspec for details.
--usage — show usage message and options.
--verbose, -v — display more information.

✨ What it does

print lines matching PATTERN for the files and revisions you specify 🌟

This command searches the specified files and revisions for a given pattern. The pattern is specified as a Python regular expression[1]. yes bestie, regex.

If you don't specify a file name, the revisions starting with the current directory get searched recursively. If you don't specify a revision number, the working copy gets searched. To search the last committed revision, use the -r -1 or -r last:1 option ✨

Unversioned files are not searched unless you explicitly specify them on the command line. Unversioned directories are not searched either. (typo in the original, we keep it, no we're not telling you which one 😌)

When searching a pattern, the output shows up in the filepath:string format. If you explicitly search a revision, the output shows as filepath~N:string, where N is the revision number.

--include and --exclude can be used to search only (or exclude from the search) files whose base name matches the specified Unix style GLOB pattern. The GLOB pattern can use *, ?, and [...] as wildcards, and \\ to quote a wildcard or backslash character literally. Note that the glob pattern is not a regular expression, don't mix them up 💅

[1] http://docs.python.org/library/re.html#regular-expression-syntax

💖 `brz help` 💖

brz help [TOPIC]

Options:

--help, -h — shows you the help message, bestie
--long — spills the tea on every single command, no skips
--quiet, -q — only errors and warnings, keep it minimal
--usage — shows the usage message and the options
--verbose, -v — more info, more vibes

Aliases: ?, --help, -?, -h

See also: topics

Show help on a command or other topic. That's it, that's the whole thing ✨

🚫 `brz ignore` 🚫

brz ignore [NAME_PATTERN...]

Options:

--default-rules — displays the default ignore rules that brz uses
--directory ARG, -d — branch to operate on, instead of the working directory
--help, -h — show help message
--quiet, -q — only display errors and warnings
--usage — show usage message and options
--verbose, -v — display more information

See also: ignored, patterns, status

Ignore specified files or patterns. Iconic behaviour honestly.

Run brz help patterns for the full deets on the syntax of patterns, iykyk.

If a .bzrignore file does not exist, the ignore command will create one and add the specified files or patterns to the newly created file. The ignore command will also automatically add the .bzrignore file to be versioned. (Creating a .bzrignore file without using the ignore command will require an explicit add command — the audacity, right?)

To remove patterns from the ignore list, edit the .bzrignore file. After adding, editing or deleting that file — either indirectly by using this command or directly by using an editor — be sure to commit it. Fr fr, don't forget 💅

Breezy also supports a global ignore file ~/.config/breezy/ignore. On Windows the global ignore file can be found in the application data directory as C:\Documents and Settings\<user>\Application Data\Breezy\3.0\ignore. Global ignores are not touched by this command. The global ignore file can be edited directly using an editor.

Patterns prefixed with '!' are exceptions to ignore patterns and take precedence over regular ignores. Such exceptions are used to specify files that should be versioned which would otherwise be ignored.

Patterns prefixed with '!!' act as regular ignore patterns, but have precedence over the '!' exception patterns.

Notes:

Ignore patterns containing shell wildcards must be quoted from the shell on Unix.
Ignore patterns starting with "#" act as comments in the ignore file. To ignore patterns that begin with that character, use the "RE:" prefix.

Examples:

Ignore the top level Makefile:

brz ignore ./Makefile

Ignore .class files in all directories...:

brz ignore "*.class"

...but do not ignore "special.class":

brz ignore "!special.class"

Ignore files whose name begins with the "#" character:

brz ignore "RE:^#"

Ignore .o files under the lib directory:

brz ignore "lib/**/*.o"

Ignore .o files under the lib directory:

brz ignore "RE:lib/.*\.o"

Ignore everything but the "debian" toplevel directory:

brz ignore "RE:(?!debian/).*"

Ignore everything except the "local" toplevel directory, but always ignore autosave files ending in ~, even under local/:

brz ignore "*"
brz ignore "!./local"
brz ignore "!!*~"

🕵️ `brz ignored` 🕵️

brz ignored

Options:

--directory ARG, -d — branch to operate on, instead of the working directory
--help, -h — show help message
--quiet, -q — only display errors and warnings
--usage — show usage message and options
--verbose, -v — display more information

See also: ignore, ls

List ignored files and the patterns that matched them. The receipts, basically 🧾

List all the ignored files and the ignore pattern that caused the file to be ignored.

Alternatively, to list just the files:

brz ls --ignored

📦 `brz import` 📦

brz import SOURCE [TREE]

Options:

--help, -h — show help message
--quiet, -q — only display errors and warnings
--usage — show usage message and options
--verbose, -v — display more information

Import sources from a directory, tarball or zip file.

This command will import a directory, tarball or zip file into a bzr tree, replacing any versioned files already present. If a directory is specified, it is used as the target. If the directory does not exist, or is not versioned, it is created.

Tarballs may be gzip or bzip2 compressed. This is autodetected — it just knows ✨

If the tarball or zip has a single root directory, that directory is stripped when extracting the tarball. This is not done for directories.

🔍 `brz info` 🔍

brz info [LOCATION]

Options:

--help, -h — show help message
--quiet, -q — only display errors and warnings
--usage — show usage message and options
--verbose, -v — display more information

See also: repositories, revno, working-trees

Show information about a working tree, branch or repository.

This command will show all known locations and formats associated to the tree, branch or repository.

In verbose mode, statistical information is included with each report. To see extended statistic information, use a verbosity level of 2 or higher by specifying the verbose option multiple times, e.g. -vv. Stack 'em up bestie 🫶

Branches and working trees will also report any missing revisions.

Examples:

Display information on the format and related locations:

brz info

Display the above together with extended format information and basic statistics (like the number of files in the working tree and number of revisions in the branch and repository):

brz info -v

Display the above together with number of committers to the branch:

brz info -vv

🌱 `brz init` 🌱

brz init [LOCATION]

Options:

--append-revisions-only — never change revnos or the existing log. Append revisions to it only.
--create-prefix — create the path leading up to the branch if it does not already exist.
--format ARG — specify a format for this branch. See "help formats" for a full list.
--2a — format for the bzr 2.0 series.
--bzr — format for the bzr 2.0 series.
--default — format for the bzr 2.0 series.
--git — GIT repository.
--git-bare — bare GIT repository (no working tree).
--help, -h — show help message
--no-tree — create a branch without a working tree.
--quiet, -q — only display errors and warnings
--usage — show usage message and options
--verbose, -v — display more information

See also: branch, checkout, init-shared-repository

Make a directory into a versioned branch. Baby's first branch energy 💖

Use this to create an empty branch, or before importing an existing project.

If there is a repository in a parent directory of the location, then the history of the branch will be stored in the repository. Otherwise init creates a standalone branch which carries its own history in the .bzr directory.

If there is already a branch at the location but it has no working tree, the tree can be populated with brz checkout.

Recipe for importing a tree of files:

cd ~/project
brz init
brz add .
brz status
brz commit -m "imported project"

🔁 `brz init-repo` 🔁

Alias for "init-shared-repository", see "brz init-shared-repository".

🔁 `brz init-shared-repo` 🔁

Alias for "init-shared-repository", see "brz init-shared-repository".

🏛️ `brz init-shared-repository` 🏛️

brz init-shared-repository LOCATION

Options:

--format ARG — specify a format for this repository. See "brz help formats" for details.
--2a — format for the bzr 2.0 series.
--bzr — format for the bzr 2.0 series.
--default — format for the bzr 2.0 series.
--git — GIT repository.
--git-bare — bare GIT repository (no working tree).
--help, -h — show help message
--no-trees — branches in the repository will default to not having a working tree.
--quiet, -q — only display errors and warnings
--usage — show usage message and options
--verbose, -v — display more information

Aliases: init-shared-repo, init-repo

See also: branch, checkout, init, repositories

Create a shared repository for branches to share storage space. Sharing is caring, periodt 👑

New branches created under the repository directory will store their revisions in the repository, not in the branch directory. For branches with shared history, this reduces the amount of storage needed and speeds up the creation of new branches. Efficiency slay.

If the --no-trees option is given then the branches in the repository will not have working trees by default. They will still exist as directories on disk, but they will not have separate copies of the files at a certain revision. This can be useful for repositories that store branches which are interacted with through checkouts or remote branches, such as on a server.

Examples:

Create a shared repository holding just branches:

brz init-shared-repo --no-trees repo
brz init repo/trunk

Make a lightweight checkout elsewhere:

brz checkout --lightweight repo/trunk trunk-checkout
cd trunk-checkout
(add files here)

🧩 `brz join` 🧩

brz join TREE

Options:

--help, -h — show help message
--quiet, -q — only display errors and warnings
--usage — show usage message and options
--verbose, -v — display more information

See also: split

Combine a tree into its containing tree.

This command requires the target tree to be in a rich-root format.

The TREE argument should be an independent tree, inside another tree, but not part of it. (Such trees can be produced by "brz split", but also by running "brz branch" with the target inside a tree.)

The result is a combined tree, with the subtree no longer an independent part. This is marked as a merge of the subtree into the containing tree, and all history is preserved. Nothing gets lost, we love to see it 💜

Options:

--help, -h — show the help message 💖
--no-check — don't check that the user name is actually valid (living dangerously, bestie)
--quiet, -q — only display errors and warnings
--service-root ARG — which Launchpad service root to connect to
--usage — show the usage message and options
--verbose, -v — display more information

Alias: lp-login 🎀

Show or set your Launchpad user ID.

So here's the tea: when you're talking to Launchpad, some commands literally need to know your Launchpad user ID. This command is the one that sets it or shows it — whichever you need. It's the user ID Bazaar will use for that communication. ✨

Examples:

Show the Launchpad ID of the current user:

brz launchpad-login

Set the Launchpad ID of the current user to bob:

brz launchpad-login bob

brz launchpad-logout

Options:

--help, -h — show the help message 💖
--quiet, -q — only display errors and warnings
--usage — show the usage message and options
--verbose, -v — display more information

Alias: lp-logout 🦋

Unset the Launchpad user ID.

Same deal as before — some Launchpad commands need your user ID, and this one logs you out. What that means practically: communication with Launchpad happens over HTTPS, and it won't need one of your SSH keys to be available. Say bye 👋

brz launchpad-open [LOCATION]

Options:

--dry-run — do not actually open the browser, just say the URL we would use 🫶
--help, -h — show the help message 💖
--quiet, -q — only display errors and warnings
--usage — show the usage message and options
--verbose, -v — display more information

Alias: lp-open 🌸

Open a Launchpad branch page in your web browser. That's it, that's the whole job. ✨

brz link-tree LOCATION

Options:

--help, -h — show the help message 💖
--quiet, -q — only display errors and warnings
--usage — show the usage message and options
--verbose, -v — display more information

Hardlink matching files to another tree.

Important deets: only files with identical content and the same execute bit will be linked. No mismatches allowed, it's picky like that 💅

brz log [FILE...]

Options:

--authors ARG — what names to list as authors — first, all or committer
--change ARG, -c — show just the specified revision. See also help revisionspec 🔍
--exclude-common-ancestry — display only the revisions that are not part of both ancestries (requires -rX..Y)
--forward — show from oldest to newest
--help, -h — show the help message 💖
--include-merged — show merged revisions like --levels 0 does
--levels N, -n — number of levels to display — 0 for all, 1 for flat
--limit N, -l — limit the output to the first N revisions
--log-format ARG — use the specified log format
--gnu-changelog — the format used by GNU ChangeLog files
--line — log format with one line per revision
--long — detailed log format
--short — moderately short log format
--match ARG, -m — show revisions whose properties match this expression
--match-author ARG — show revisions whose authors match this expression
--match-bugs ARG — show revisions whose bugs match this expression
--match-committer ARG — show revisions whose committer matches this expression
--match-message ARG — show revisions whose message matches this expression
--omit-merges — do not report commits with more than one parent
--quiet, -q — only display errors and warnings
--revision ARG, -r — see help revisionspec for the details
--show-diff, -p — show the changes made in each revision as a patch
--show-ids — show internal object ids
--signatures — show digital signature validity
--timezone ARG — display timezone as local, original, or utc
--usage — show the usage message and options
--verbose, -v — show the files changed in each revision

🌸 `brz lp-find-proposal`

✨ OPTIONS ✨

--help, -h — Show help message.
--quiet, -q — Only display errors and warnings.
--revision ARG, -r — See help revisionspec for details.
--usage — Show usage message and options.
--verbose, -v — Display more information.

💖 DESCRIPTION 💖

Find the proposal to merge this revision. That's the whole vibe.

It finds the merge proposal(s) that discussed landing the specified revision. Big caveat though, no cap: this only works if the merged_revno was recorded for the merge proposal. (Yes, the original says "if the if" — we love a typo era. 🙈) The proposal(s) get opened in a web browser, so get ready for tabs, bestie.

Only the revision you specified is searched for. If you wanna find the mainline revision that merged it into mainline, use the mainline revision spec.

So, to find the merge proposal that reviewed line 1 of README:

brz lp-find-proposal -r mainline:annotate:README:1

🦋 `brz lp-login`

Alias for launchpad-login, see brz launchpad-login. That's it, that's the whole thing. Go read that one. 💜

🦋 `brz lp-logout`

Alias for launchpad-logout, see brz launchpad-logout. Same energy, still an alias. 🌸

🦋 `brz lp-open`

Alias for launchpad-open, see brz launchpad-open. Three for three on the alias train. 🎀

👑 `brz ls [PATH]`

✨ OPTIONS ✨

--directory ARG, -d — Branch to operate on, instead of working directory.
--from-root — Print paths relative to the root of the branch.
--help, -h — Show help message.
--ignored, -i — Print ignored files.
--kind ARG, -k — List entries of a particular kind: file, directory, symlink, tree-reference.
--null, -0 — Use an ASCII NUL (\0) separator rather than a newline.
--quiet, -q — Only display errors and warnings.
--recursive, -R — Recurse into subdirectories.
--revision ARG, -r — See help revisionspec for details.
--show-ids — Show internal object ids.
--unknown, -u — Print unknown files.
--usage — Show usage message and options.
--verbose, -v — Display more information.
--versioned, -V — Print versioned files.

💖 DESCRIPTION 💖

List files in a tree.</puruple> Short, sweet, slays. 🌈

🔥 `brz merge [LOCATION]`

✨ OPTIONS ✨

--change ARG, -c — Select changes introduced by the specified revision. See also help revisionspec.
--directory ARG, -d — Branch to merge into, rather than the one containing the working directory.
--force — Merge even if the destination tree has uncommitted changes.
--help, -h — Show help message.
--interactive, -i — Select changes interactively.
--merge-type ARG — Select a particular merge algorithm.
- --diff3 — Merge using external diff3.
- --lca — LCA-newness merge.
- --merge3 — Native diff3-style merge.
- --weave — Weave-based merge.
--preview — Instead of merging, show a diff of the merge.
--pull — If the destination is already completely merged into the source, pull from the source rather than merging. When this happens, you do not need to commit the result.
--quiet, -q — Only display errors and warnings.
--remember — Remember the specified location as a default.
--reprocess — Reprocess to reduce spurious conflicts.
--revision ARG, -r — See help revisionspec for details.
--show-base — Show base revision text in conflicts.
--uncommitted — Apply uncommitted changes from a working copy, instead of branch changes.
--usage — Show usage message and options.
--verbose, -v — Display more information.

See also: remerge, send, status-flags, update

💖 DESCRIPTION 💖

Perform a three-way merge. The main character of version control moves, honestly. 👑

So where can the source of the merge come from? Either:

A branch, OR
A path to a file containing a merge directive generated with brz send.

If you specify neither, the default is the upstream branch, or the branch most recently merged using --remember. And plot twist: the source of the merge may also be specified as a path to a file in another branch — in which case only the modifications to that file get merged into the current working tree. Small merge, tiny merge, niche merge. 🦋

When merging from a branch, by default brz tries to merge in all new work from the other branch, automatically figuring out an appropriate base revision. If that fails? You may need to give an explicit base. Not the algorithm's fault, it's just ~life~.

To pick a different ending revision, pass --revision OTHER. brz will try to merge in all new work up to and including revision OTHER.

If you specify two values, --revision BASE..OTHER, then only revisions BASE through OTHER, excluding BASE but including OTHER, will be merged. If this causes some revisions to be skipped — like, if the destination branch does not already contain revision BASE — a merge like that is commonly called a "cherrypick". And here's the caveat bestie, listen up: unlike a normal merge, Breezy does not currently track cherrypicks. The changes look like a normal commit, and the history of the changes from the other branch is not stored in the commit. So act accordingly. 😭

Revision numbers are always relative to the source branch. Always. No exceptions, periodt.

Merge will do its best to combine the changes in two branches, but some kinds of problems can only be fixed by a human. When it hits one of those, it will mark a conflict. A conflict means you need to fix something before you can commit. That's the deal.

Use brz resolve when you've fixed a problem. See also brz conflicts.

If there's no default branch set, the first merge will set it (use --no-remember to avoid setting it). After that, you can omit the branch and it'll use the default. To change the default, use --remember. And heads up: the value will only be saved if the remote location can be accessed. If it can't be reached, nothing gets remembered, sorry. 💀

The results of the merge get placed into the destination working directory, where you can review them (with brz diff), test them, and then commit to record the result of the merge. Review → test → commit. That's the pipeline.

merge refuses to run if there are any uncommitted changes, unless --force is given. If --force is given, then the changes from the source will be merged with the current working tree, including any uncommitted changes in the tree. And --force can also be used to create a merge revision which has more than two parents. Polyamory but for commits. 🫶

If you want to merge changes from the working tree of the other branch without merging any committed revisions, pass the --uncommitted option.

To select only some changes to merge, use merge -i, which will prompt you to apply each diff hunk and file change, similar to shelve. Interactive merge, we love her. ✨

Examples

To merge all new revisions from brz.dev:

brz merge ../brz.dev

To merge changes up to and including revision 82 from brz.dev:

brz merge -r 82 ../brz.dev

To merge the changes introduced by 82, without previous changes:

brz merge -r 81..82 ../brz.dev

To apply a merge directive contained in /tmp/merge:

brz merge /tmp/merge

To create a merge revision with three parents from two branches feature1a and feature1b:

brz merge ../feature1a
brz merge ../feature1b --force
brz commit -m 'revision with three parents'

🌈 `brz missing [OTHER_BRANCH]`

✨ OPTIONS ✨

--directory ARG, -d — Branch to operate on, instead of working directory.
--help, -h — Show help message.
--include-merged — Show all revisions in addition to the mainline ones.
--log-format ARG — Use specified log format.
- --gnu-changelog — Format used by GNU ChangeLog files.
- --line — Log format with one line per revision.
- --long — Detailed log format.
- --short — Moderately short log format.
--mine-only — Display changes in the local branch only.
--my-revision ARG — Filter on local branch revisions (inclusive). See help revisionspec for details.
--other — Same as --theirs-only.
--quiet, -q — Only display errors and warnings.
--reverse — Reverse the order of revisions.
--revision ARG, -r — Filter on other branch revisions (inclusive). See help revisionspec for details.
--show-ids — Show internal object ids.
--theirs-only — Display changes in the remote branch only.
--this — Same as --mine-only.
--usage — Show usage message and options.
--verbose, -v — Display more information.

💖 DESCRIPTION 💖

Show unmerged/unpulled revisions between two branches. The "what am I missing" of it all. 🔍

OTHER_BRANCH may be local or remote — both are welcome here.

To filter on a range of revisions, you can use the command -r begin..end. -r revision requests a specific revision, and -r ..end or -r begin.. are also valid. Ranges are flexible like that, bestie. 🎀

Exit values

1 - some missing revisions
0 - no missing revisions

So if it exits 1, yeah, there's stuff missing. If it exits 0, you're fully caught up. Simple. Clean. Iconic.

Examples

Determine the missing revisions between this and the branch at the remembered pull location:

brz missing

Determine the missing revisions between this and another branch:

brz missing http://server/branch

Determine the missing revisions up to a specific revision on the other branch:

brz missing -r ..-10

Determine the missing revisions up to a specific revision on this branch:

brz missing --my-revision ..-10

🌸 `brz mkdir DIR...`

Options:

--help, -h — shows you the help message, bestie 💖
--parents, -p — no error if it already exists, and it'll make the parent directories as needed. so forgiving, we love that.
--quiet, -q — only shows errors and warnings. silent-ish era.
--usage — shows the usage message and options.
--verbose, -v — displays more information.

Makes a brand-new versioned directory. ✨

It's literally the same thing as creating the directory and then adding it — two steps, one command, iconic behaviour. 💅

🦋 `brz move`

Alias for mv, so go look at brz mv. Same vibe, shorter name. 🫶

`brz mv [NAMES...]`

Options:

--after — move only the brz identifier of the file, for when the file has already been moved. like, the deed is done, we're just updating the receipts. 🙈
--auto — automatically guess renames.
--dry-run — avoids making changes while it's guessing renames. a little sneak peek, no commitment.
--help, -h — shows the help message.
--quiet, -q — only shows errors and warnings.
--usage — shows the usage message and options.
--verbose, -v — displays more information.

Aliases: move, rename

Moves or renames a file. ✨

Usage:

brz mv OLDNAME NEWNAME

brz mv SOURCE... DESTINATION

If that last argument is a versioned directory, then all the other names get moved into it. Otherwise you need exactly two arguments, and the file gets changed to a new name. no extra, no fewer. periodt. 💅

Now the plot twist: if OLDNAME does not exist on the filesystem but is versioned, and NEWNAME does exist on the filesystem but is not versioned, mv assumes you manually moved the file yourself and only updates its internal inventory to reflect that change. Same deal when you're moving many SOURCE files to a DESTINATION. 😌

🚫 Files cannot be moved between branches. not a vibe, not allowed, don't try it.

🎀 `brz nick [NICKNAME]`

Options:

--directory ARG, -d — branch to operate on, instead of the working directory.
--help, -h — shows the help message.
--quiet, -q — only shows errors and warnings.
--usage — shows the usage message and options.
--verbose, -v — displays more information.

See also: info

Prints or sets the branch nickname. 🏷️

If it's unset, the colocated branch name gets used for colocated branches, and the branch directory name gets used for other branches. To just print the current nickname, run it with no argument at all. 💖

Bound branches use the nickname of their master branch — unless it's been set locally. 👑

🧚 `brz pack [BRANCH_OR_REPO]`

Options:

--clean-obsolete-packs — deletes obsolete packs to save disk space.
--help, -h — shows the help message.
--quiet, -q — only shows errors and warnings.
--usage — shows the usage message and options.
--verbose, -v — displays more information.

See also: repositories

Compresses the data within a repository. 🗜️✨

This operation compresses the data inside a bazaar repository. And because bazaar supports automatic packing of repositories, you normally don't need to do this manually. it just... happens. main character energy, honestly.

During the pack operation, bazaar takes a backup of the existing repository data (i.e. the pack files). That backup eventually gets removed by bazaar automatically once it's safe to do so. If you wanna save disk space by removing those backed-up pack files yourself, you can use the --clean-obsolete-packs option. 🧹

⚠️ Warning: if you use --clean-obsolete-packs and your machine crashes during or immediately after repacking, you may be left in a state where the deletion has been written to disk but the new packs have not been. In that case, the repository may be unusable. 😭 please be careful.

`brz patch [FILENAME]`

Options:

--help, -h — shows the help message.
--quiet, -q — only shows errors and warnings.
--silent — suppresses chatter. 🤫
--strip ARG, -p — strips the smallest prefix containing num leading slashes from filenames.
--usage — shows the usage message and options.
--verbose, -v — displays more information.

Applies a named patch to the current tree. 🩹💖

⭐ `brz ping LOCATION`

Options:

--help, -h — shows the help message.
--quiet, -q — only shows errors and warnings.
--usage — shows the usage message and options.
--verbose, -v — displays more information.

Pings a Bazaar smart server. 📡

Basically it sends a 'hello' request to the location you give it, using the brz smart protocol, and then reports back the response. like a lil "u up?" to the server. 👋

🌈 `brz plugins`

Options:

--help, -h — shows the help message.
--quiet, -q — only shows errors and warnings.
--usage — shows the usage message and options.
--verbose, -v — displays more information.

Lists the installed plugins. 🧩✨

This command displays the list of installed plugins, including the version of each plugin and a short description of each one. ✨

--verbose shows you the path where each plugin is located. 📂

A plugin is an external component for Breezy that extends the revision control system, by adding or replacing code in Breezy. Plugins can do a whole variety of things — including overriding commands, adding new commands, providing additional network transports, and customizing log output. the range?? unmatched. 👑

See the Breezy Plugin Guide at https://www.breezy-vcs.org/doc/plugins/en/ for further information on plugins, including where to find them and how to install them. There are also instructions there on how to write new plugins using the Python programming language. 🐍💅

💜 `brz praise`

Alias for annotate, so go see brz annotate. 🫡

🔥 `brz pull [LOCATION]`

Options:

--directory ARG, -d — branch to pull into, rather than the one containing the working directory.
--help, -h — shows the help message.
--local — performs a local pull in a bound branch. Local pulls are not applied to the master branch.
--overwrite — ignores differences between branches and overwrites unconditionally. brutal. love it.
--overwrite-tags — overwrites tags only.
--quiet, -q — only shows errors and warnings.
--remember — remembers the specified location as a default.
--revision ARG, -r — see "help revisionspec" for details.
--show-base — show base revision text in conflicts.
--usage — shows the usage message and options.
--verbose, -v — shows logs of pulled revisions.

See also: push, send, status-flags, update

Turns this branch into a mirror of another branch. 🪞✨

By default, this command only works on branches that have not diverged. Branches are considered diverged if the destination branch's most recent commit is one that hasn't been merged (directly or indirectly) into the parent. 😬

If the branches have diverged, you can use 'brz merge' to integrate the changes from one into the other. Once one branch has merged, the other should be able to pull it again. teamwork, bestie. 🫶

If you wanna replace your local changes and just want your branch to match the remote one, use pull --overwrite. This will work even if the two branches have diverged. 💥

If there's no default location set, the first pull will set it (use --no-remember to avoid setting it). After that, you can omit the location and it'll use the default. To change the default, use --remember. The value will only be saved if the remote location can be accessed. 👀

The --verbose option displays the revisions pulled using the log_format configuration option. You can use a different format by overriding it with -Olog_format=<other_format>. 💅

📝 Note: the location can be specified either in the form of a branch, or in the form of a path to a file containing a merge directive generated with brz send.

👑 `brz push [LOCATION]`

Options:

--create-prefix — creates the path leading up to the branch if it doesn't already exist.
--directory ARG, -d — branch to push from, rather than the one containing the working directory.
--help, -h — shows the help message.
--lossy — allows a lossy push, i.e. dropping metadata that can't be represented in the target. yikes, but okay.
--no-tree — don't populate the working tree, even for protocols that support it.
--overwrite — ignores differences between branches and overwrites unconditionally.
--overwrite-tags — overwrites tags only.
--quiet, -q — only shows errors and warnings.
--remember — remembers the specified location as a default.
--revision ARG, -r — see "help revisionspec" for details.
--stacked — creates a stacked branch that references the public location of the parent branch.
--stacked-on ARG — creates a stacked branch that refers to another branch for the commit history. Only the work not present in the referenced branch is included in the branch created.
--strict — refuses to push if there are uncommitted changes in the working tree. --no-strict disables the check.
--usage — shows the usage message and options.
--use-existing-dir — by default, push will fail if the target directory exists but doesn't already have a control directory. This flag lets push proceed anyway.
--verbose, -v — displays more information.

See also: pull, update, working-trees

Updates a mirror of this branch. 🪞💨

The target branch will not have its working tree populated, because that's both expensive and not supported on remote file systems. we're not doing all that. 🙅

Some smart servers or protocols may put the working tree in place in the future. maybe. someday. who knows. 🔮

This command only works on branches that have not diverged. Branches are considered diverged if the destination branch's most recent commit is one that hasn't been merged (directly or indirectly) by the source branch. 😵‍💫

If the branches have diverged, you can use 'brz push --overwrite' to replace the other branch completely, discarding its unmerged changes. 💀 gone, deleted, no takebacks.

If you want to make sure you've got the different changes that live in the other branch, do a merge (peep brz help merge) from that other branch, and then commit it. After that you'll be able to push with no --overwrite at all. 💅

No default push location set yet? Then the first push sets it for you (use --no-remember if you're like "no thank u"). After that you can just leave the location out entirely and it'll use the default. Wanna swap the default? Use --remember. Tiny catch tho: the value only gets saved if the remote location can actually be accessed. 🫶

--verbose will show you the revisions that got pushed, formatted using the log_format configuration option. Want a different look? Override it with -Olog_format=<other_format> and go off. ✨

💖 `brz reconcile [BRANCH]`

Options:

--help, -h — Show help message.
--quiet, -q — Only display errors and warnings.
--usage — Show usage message and options.
--verbose, -v — Display more information.

🎀 `brz reconfigure [LOCATION]`

Options:

--bind-to ARG — Branch to bind checkout to.
--force — Perform reconfiguration even if local changes will be lost.
--help, -h — Show help message.
--quiet, -q — Only display errors and warnings.
--repository_trees ARG — Whether new branches in the repository have trees.
--with-no-trees — Reconfigure repository to not create working trees on branches by default.
--with-trees — Reconfigure repository to create working trees on branches by default.
--repository_type ARG — Location for the repository.
--standalone — Reconfigure to be a standalone branch (i.e. stop using shared repository).
--use-shared — Reconfigure to use a shared repository.
--stacked-on ARG — Reconfigure a branch to be stacked on another branch.
--tree_type ARG — The relation between branch and tree.
--branch — Reconfigure to be an unbound branch with no working tree.
--checkout — Reconfigure to be a bound branch with a working tree.
--lightweight-checkout — Reconfigure to be a lightweight checkout (with no local history).
--tree — Reconfigure to be an unbound branch with a working tree.
--unstacked — Reconfigure a branch to be unstacked. This may require copying substantial data into it.
--usage — Show usage message and options.
--verbose, -v — Display more information.

See also: branches, checkouts, standalone-trees, working-trees

Reconfigure the type of a brz directory.

Okay so, a target configuration must be specified — you can't just say "reconfigure" and hope for the best, bestie. Pick a lane. 💅

For checkouts, the bind-to location gets auto-detected if you don't specify it. The order of preference is:

For a lightweight checkout, the current bound location.
For branches that used to be checkouts, the previously-bound location.
The push location.
The parent location.

And if literally none of those are available? Then --bind-to must be specified. No getting around it. 😭

🦋 `brz remerge [FILE...]`

Options:

--help, -h — Show help message.
--merge-type ARG — Select a particular merge algorithm.
--diff3 — Merge using external diff3.
--lca — LCA-newness merge.
--merge3 — Native diff3-style merge.
--weave — Weave-based merge.
--quiet, -q — Only display errors and warnings.
--reprocess — Reprocess to reduce spurious conflicts.
--show-base — Show base revision text in conflicts.
--usage — Show usage message and options.
--verbose, -v — Display more information.

Redo a merge.

Use this when you wanna try a different merge technique while you're out here resolving conflicts. Some merge techniques are just better than others, and remerge lets you try different ones on different files. So picky, so powerful. ✨

The options for remerge have the same meaning and defaults as the ones for merge. The difference is that remerge can (only) be run when there is a pending merge, and it lets you specify particular files. 🔥

Examples:

Re-do the merge of all conflicted files, and show the base text in conflict regions, in addition to the usual THIS and OTHER texts:

brz remerge --show-base

Re-do the merge of "foobar", using the weave merge algorithm, with additional processing to reduce the size of conflict regions:

brz remerge --merge-type weave --reprocess foobar

🍓 `brz remove [FILE...]`

Options:

--file-deletion-strategy ARG — The file deletion mode to be used.
--keep — Delete from brz but leave the working copy.
--no-backup — Don't backup changed files.
--safe — Backup changed files (default).
--help, -h — Show help message.
--new — Only remove files that have never been committed.
--quiet, -q — Only display errors and warnings.
--usage — Show usage message and options.
--verbose, -v — Display more information.

Aliases: rm, del

Remove files or directories.

This makes Breezy stop tracking changes to the files you named. Breezy will delete them if they can easily be recovered using revert, otherwise they'll be backed up (adding an extension of the form .~#~). And if you give it no options and no parameters? Breezy will scan for files that are being tracked by Breezy but missing in your tree, and stop tracking them for you. Look at her being helpful. 💅

🌸 `brz remove-branch [LOCATION]`

Options:

--directory ARG, -d — Branch to operate on, instead of working directory.
--force — Remove branch even if it is the active branch.
--help, -h — Show help message.
--quiet, -q — Only display errors and warnings.
--usage — Show usage message and options.
--verbose, -v — Display more information.

Alias: rmbranch

Remove a branch.

This removes the branch from the location you specified but will keep any working tree or repository in place. Like, the branch ghosted, the tree stayed. 👻

Examples:

Remove the branch at repo/trunk:

brz remove-branch repo/trunk

💜 `brz remove-tree [LOCATION...]`

Options:

--force — Remove the working tree even if it has uncommitted or shelved changes.
--help, -h — Show help message.
--quiet, -q — Only display errors and warnings.
--usage — Show usage message and options.
--verbose, -v — Display more information.

⭐ `brz rename`

Alias for "mv", see "brz mv".

🧚 `brz renames [DIR]`

Options:

--help, -h — Show help message.
--quiet, -q — Only display errors and warnings.
--usage — Show usage message and options.
--verbose, -v — Display more information.

👑 `brz resolve [FILE...]`

Options:

--action ARG — How to resolve the conflict.
--auto — Detect whether conflict has been resolved by user.
--done — Marks the conflict as resolved.
--take-other — Resolve the conflict taking the merged version into account.
--take-this — Resolve the conflict preserving the version in the working tree.
--all — Resolve all conflicts in this tree.
--directory ARG, -d — Branch to operate on, instead of working directory.
--help, -h — Show help message.
--quiet, -q — Only display errors and warnings.
--usage — Show usage message and options.
--verbose, -v — Display more information.

Alias: resolved

🌈 `brz resolved`

Alias for "resolve", see "brz resolve".

🫶 `brz revert [FILE...]`

Options:

--forget-merges — Remove pending merge marker, without changing any files.
--help, -h — Show help message.
--no-backup — Do not save backups of reverted files.
--quiet, -q — Only display errors and warnings.
--revision ARG, -r — See "help revisionspec" for details.
--usage — Show usage message and options.
--verbose, -v — Display more information.

See also: cat, export, merge, shelve

Set files in the working tree back to the contents of a previous revision.

Giving it a list of files means only those files get reverted. No list? Then every single file gets reverted 💀. If you don't name a revision with --revision, it uses the working tree basis revision. And listen — a revert op only touches the working tree, not any revision history like the branch, the repo, or the working tree basis revision. It's cosmetic-ish, bestie, it doesn't rewrite the past ✨

Wanna remove only some changes, without going all the way back to a prior version? That's a merge job instead. Like, merge . -r -2..-3 (do not forget the ., I'm begging 🙏) will remove the changes introduced by the second last commit (-2), without affecting the changes introduced by the last commit (-1). And if you want to nuke certain changes on a hunk-by-hunk basis, go peek at the shelve command. Want the branch updated to a specific revision (or the latest) with the working tree following along while your local changes stay safe? That's the update command, bestie 🔥

⚠️ Uncommitted changes to files that are reverted will be discarded. Periodt.

Okay but lowkey there's a safety net: by default, any files that have been manually changed get backed up first. (Files changed only by merge are not backed up, so watch out there 🙈.) Backups get .~#~ appended to their name, where # is a number. Cute little name tag for your grief 🎀

When you hand over files, you can use their current pathname or the pathname from the target revision. Which means revert can straight up "undelete" a file by name — resurrection era 💅. And if you name a directory, everything inside that directory gets reverted too.

Newly added files since the target revision? They get removed. If the files being removed have been changed, backups happen as described above. Directories containing unknown files will not be deleted though — respect 🫶

The working tree holds a list of revisions that have been merged but not yet committed, and those revisions get included as additional parents of the next commit. Normally, running revert clears that list and reverts the files. But if any files are specified, revert leaves the list of uncommitted merges alone and reverts only the files. So:

Use brz revert in the tree root to revert all files but keep the recorded merges.
Use brz revert --forget-merges to clear the pending merge list without reverting any files.

With brz revert --forget-merges you can actually apply all of the changes from a branch in a single revision 😳. How? Do the merge as desired. Then running revert with the --forget-merges option keeps the content of the tree exactly as it was, but clears the list of pending merges. The next commit will then contain all of the changes present in the other branch, with no other parent revisions. Lowkey iconic... but because this technique forgets where those changes came from, it may cause additional conflicts on later merges involving the same source and target branches. You've been warned, bestie 💀

brz revno [LOCATION]

Options:

--help, -h — Show help message.
--quiet, -q — Only display errors and warnings.
--revision ARG, -r — See help revisionspec for details.
--tree — Show revno of working tree.
--usage — Show usage message and options.
--verbose, -v — Display more information.

See also: info

Show the current revision number ✨

It's literally equal to the number of revisions on this branch. Math girlies stay winning 📐💖

brz rm

Alias for remove, see brz remove. 💅

brz rmbranch

Alias for remove-branch, see brz remove-branch. 💅

brz root [FILENAME]

Options:

--help, -h — Show help message.
--quiet, -q — Only display errors and warnings.
--usage — Show usage message and options.
--verbose, -v — Display more information.

Show the tree root directory 🌳

The root is the nearest enclosing directory that has a control directory in it. That's the one, bestie 👑

brz send [SUBMIT_BRANCH] [PUBLIC_BRANCH]

Options:

--body ARG — Body for the email.
--format ARG — Use the specified output format.
--from ARG, -f — Branch to generate the submission from, rather than the one containing the working directory.
--help, -h — Show help message.
--mail-to ARG — Mail the request to this address.
--message ARG, -m — Message string.
--no-bundle — Do not include a bundle in the merge directive.
--no-patch — Do not include a preview patch in the merge directive.
--output ARG, -o — Write merge directive to this file or directory; use - for stdout.
--quiet, -q — Only display errors and warnings.
--remember — Remember submit and public branch.
--revision ARG, -r — See help revisionspec for details.
--strict — Refuse to send if there are uncommitted changes in the working tree; --no-strict disables the check.
--usage — Show usage message and options.
--verbose, -v — Display more information.

See also: merge, pull

Mail or create a merge-directive for submitting changes 📬

A merge directive provides a bunch of things you need for requesting merges:

A machine-readable description of the merge to perform.
An optional patch that is a preview of the changes requested.
An optional bundle of revision data, so the changes can be applied directly from the merge directive, without retrieving data from a branch.

brz send creates a compact data set that, when applied using brz merge, has the exact same effect as merging from the source branch. No cap 🧢

By default the merge directive is self-contained and can be applied to any branch containing submit_branch in its ancestory without needing access to the source branch ✨

If --no-bundle is specified, then Breezy doesn't send the contents of the revisions — it only sends a structured request to merge from the public_location. In that case the public_branch is needed and it must be up-to-date and accessible to the recipient. The public_branch is always included if known, so people can check it later 👀

The submit branch defaults to the parent of the source branch, but you can override it. Both the submit branch and the public branch get remembered in branch.conf the first time they're used for a particular branch. The source branch defaults to the one containing the working directory, but you can change it with --from.

Both the submit branch and the public branch follow the usual behavior with respect to --remember: if there's no default location set, the first send sets it (use --no-remember to avoid setting it 😌). After that, you can just omit the location and get the default. Wanna change the default? Use --remember. The value will only be saved if the location can actually be accessed, bestie 🔒

To calculate those changes, brz has to analyse the submit branch. So it's most efficient for the submit branch to be a local mirror. And if a public location is known for the submit_branch, that location is used in the merge directive.

Default behaviour is to send the merge directive by mail, unless you pass -o, in which case it goes to a file 📁

Mail is sent using your preferred mail program. This should be transparent on Windows (it uses MAPI). On Unix it requires the xdg-email utility. And if the preferred client can't be found (or used), your editor will be used instead. Fallback queen 👑

To use a specific mail program, set the mail_client configuration option. Supported values for specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's Mail.app), "mutt", and "thunderbird"; generic options are "default", "editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add supported clients 💅

If mail is being sent, a to address is required. You can supply it either on the commandline, by setting the submit_to configuration option in the branch itself, or the child_submit_to configuration option in the submit branch 📮

The merge directives created by brz send may be applied using brz merge or brz pull by specifying a file containing a merge directive as the location.

brz send makes extensive use of public locations to map local locations into URLs that other people can use. See brz help configuration to set them, and use brz info to display them 🌈

brz serve

Options:

--allow-writes — By default the server is a readonly server. Supplying --allow-writes enables write access to the contents of the served directory and below. Note that brz serve does not perform authentication, so unless some form of external authentication is arranged, supplying this option leads to global uncontrolled write access to your file system.
--client-timeout ARG — Override the default idle client timeout (5min).
--directory ARG, -d — Serve contents of this directory.
--help, -h — Show help message.
--inet — Serve on stdin/out for use from inetd or sshd.
--listen ARG — Listen for connections on nominated address.
--port ARG — Listen for connections on nominated port. Passing 0 as the port number will result in a dynamically allocated port. The default port depends on the protocol.
--protocol ARG — Protocol to serve.
--bzr — The Bazaar smart server protocol over TCP. (default port: 4155)
--git — Git Smart server protocol over TCP. (default port: 9418)
--git-receive-pack — Git Smart server receive pack command. (inetd mode only)
--git-upload-pack — Git Smart server upload pack command. (inetd mode only)
--quiet, -q — Only display errors and warnings.
--usage — Show usage message and options.
--verbose, -v — Display more information.

🔥 DANGER, BESTIE: brz serve does not perform authentication. So unless some form of external authentication is arranged, supplying --allow-writes leads to global uncontrolled write access to your file system 💀💀💀 Do not do this casually.

Alias: server

Run the brz server 🖥️✨

brz server

Alias for serve, see brz serve. 💅

`brz shelve [FILE...]` 🧺

Options:

--all — shelve literally every change you got.
--destroy — destroy changes that got removed instead of shelving them.
--directory ARG, -d — the branch to operate on, instead of the working directory.
--help, -h — show the help message.
--list — list the shelved changes.
--message ARG, -m — a message string.
--quiet, -q — only display errors and warnings.
--revision ARG, -r — check help revisionspec for the deets.
--usage — show the usage message and options.
--verbose, -v — display more information.
--writer ARG — which method to use for writing diffs.
--plain — plaintext diff output.

`brz sign-my-commits [LOCATION] [COMMITTER]` ✍️

Options:

--dry-run — don't actually sign anything, just print which revisions would get signed.
--help, -h — show the help message.
--quiet, -q — only display errors and warnings.
--usage — show the usage message and options.
--verbose, -v — display more information.

Sign all commits by a given committer. That's the whole vibe.

If location isn't specified, the local tree is used. If committer isn't specified, the default committer is used.

Heads up: this does not sign commits that already have signatures. Already-signed is already-signed, bestie. 🙈

`brz split TREE` 🪓

Options:

--help, -h — show the help message.
--quiet, -q — only display errors and warnings.
--usage — show the usage message and options.
--verbose, -v — display more information.

`brz st` 🌟

Alias for status, see brz status.

`brz stat` 🌟

Alias for status, see brz status.

`brz status [FILE...]` 👀

Options:

--change ARG, -c — select changes introduced by the specified revision. Also see help revisionspec.
--help, -h — show the help message.
--no-classify — don't mark object type using an indicator.
--no-pending — don't show pending merges.
--quiet, -q — only display errors and warnings.
--revision ARG, -r — check help revisionspec for the deets.
--short, -S — use short status indicators.
--show-ids — show internal object ids.
--usage — show the usage message and options.
--verbose, -v — display more information.
--versioned, -V — only show versioned files.

Aliases: st, stat

`brz switch [TO_LOCATION]` 🔄

Options:

--create-branch, -b — create the target branch from this one before switching to it.
--directory ARG, -d — branch to operate on, instead of the working directory.
--force — switch even if local commits will be lost.
--help, -h — show the help message.
--quiet, -q — only display errors and warnings.
--revision ARG, -r — check help revisionspec for the deets.
--store — store and restore uncommitted changes in the branch.
--usage — show the usage message and options.
--verbose, -v — display more information.

Set the branch of a checkout and update. It's the glow-up command. 🌈

For lightweight checkouts, this changes which branch is being referenced.

For heavyweight checkouts, it first checks that there are no local commits versus the current bound branch, then it makes the local branch a mirror of the new location and binds to it.

In both cases, the working tree gets updated and uncommitted changes are merged. You can then commit or revert them as you desire, your call bestie.

Pending merges need to be committed or reverted before you can use switch. No skipping that step. 😤

The path to the branch you're switching to can be specified relative to the parent directory of the current branch. For example, if you're currently in a checkout of /path/to/branch, specifying newbranch will find a branch at /path/to/newbranch. Cute, right?

Bound branches use the nickname of their master branch unless it's set locally — and in that case, switching updates the local nickname to be that of the master. 💅

`brz tag [TAG_NAME]` 🏷️

Options:

--delete — delete this tag rather than placing it.
--directory ARG, -d — branch in which to place the tag.
--force — replace existing tags.
--help, -h — show the help message.
--quiet, -q — only display errors and warnings.
--revision ARG, -r — check help revisionspec for the deets.
--usage — show the usage message and options.
--verbose, -v — display more information.

`brz tags` 📋

Options:

--directory ARG, -d — branch whose tags should be displayed.
--help, -h — show the help message.
--quiet, -q — only display errors and warnings.
--revision ARG, -r — check help revisionspec for the deets.
--show-ids — show internal object ids.
--sort ARG — sort tags by different criteria.
--usage — show the usage message and options.
--verbose, -v — display more information.

💌 `brz testament [BRANCH]`

Options:

--help, -h — show the help message, bestie
--long — produce a long-format testament
--quiet, -q — only display errors and warnings
--revision ARG, -r — see help revisionspec for the details
--strict — produce a strict-format testament
--usage — show usage message and options
--verbose, -v — display more information

Show the testament (signing-form) of a revision. ✨

🔓 `brz unbind`

Options:

--directory ARG, -d — branch to operate on, instead of working directory
--help, -h — show help message
--quiet, -q — only display errors and warnings
--usage — show usage message and options
--verbose, -v — display more information

⏪ `brz uncommit [LOCATION]`

Options:

--dry-run — don't actually make changes
--force — say yes to all questions
--help, -h — show help message
--keep-tags — keep tags that point to removed revisions
--local — only remove the commits from the local branch when in a checkout
--quiet, -q — only display errors and warnings
--revision ARG, -r — see help revisionspec for the details
--usage — show usage message and options
--verbose, -v — display more information

🧺 `brz unshelve [SHELF_ID]`

Options:

--action ARG — the action to perform
--apply — apply changes and remove from the shelf
--delete-only — delete changes without applying them
--dry-run — show changes, but do not apply or remove them
--keep — apply changes but don't delete them
--preview — instead of unshelving the changes, show the diff that would result from unshelving
--directory ARG, -d — branch to operate on, instead of working directory
--help, -h — show help message
--quiet, -q — only display errors and warnings
--usage — show usage message and options
--verbose, -v — display more information

⬆️ `brz up`

Alias for update, see brz update. That's it, that's the whole entry. 💅

🔄 `brz update [DIR]`

Options:

--help, -h — show help message
--quiet, -q — only display errors and warnings
--revision ARG, -r — see help revisionspec for the details
--show-base — show base revision text in conflicts
--usage — show usage message and options
--verbose, -v — display more information

Alias: up

See also: pull, status-flags, working-trees

Update a working tree to a new revision. 🌈

This will perform a merge of the destination revision (the tip of the branch, or the specified revision) into the working tree, and then make that revision the basis revision for the working tree.

You can use this to visit an older revision, or to update a working tree that is out of date from its branch. time travel, lowkey. 🕰️

If there are any uncommitted changes in the tree, they will be carried across and remain as uncommitted changes after the update. To discard these changes, use brz revert. Heads up though — the uncommitted changes may conflict with the changes brought in by the change in basis revision. 😭

If the tree's branch is bound to a master branch, brz will also update the branch from the master. 👑

You cannot update just a single file or directory, because each Breezy working tree has just a single basis revision. If you want to restore a file that has been removed locally, use brz revert instead of brz update. If you want to restore a file to its state in a previous revision, use brz revert with a -r option, or use brz cat to write out the old content of that file to a new location.

The dir argument, if given, must be the location of the root of a working tree to update. By default, the working tree that contains the current working directory is used.

🚀 `brz upgrade [URL]`

Options:

--clean — remove the backup.bzr directory if successful
--dry-run — show what would be done, but don't actually do anything
--format ARG — upgrade to a specific format. See brz help formats for details
--2a — format for the bzr 2.0 series
--bzr — format for the bzr 2.0 series
--default — format for the bzr 2.0 series
--git — GIT repository
--git-bare — bare GIT repository (no working tree)
--help, -h — show help message
--quiet, -q — only display errors and warnings
--usage — show usage message and options
--verbose, -v — display more information

🔐 `brz verify-signatures [LOCATION]`

Options:

--acceptable-keys ARG, -k — comma separated list of GPG key patterns which are acceptable for verification
--help, -h — show help message
--quiet, -q — only display errors and warnings
--revision ARG, -r — see help revisionspec for the details
--usage — show usage message and options
--verbose, -v — display more information

Verify all commit signatures. 🔎

Verifies that all commits in the branch are signed by known GnuPG keys. if it ain't signed, it ain't it. 🎀

🏷️ `brz version`

Options:

--help, -h — show help message
--quiet, -q — only display errors and warnings
--short — print just the version number
--usage — show usage message and options
--verbose, -v — display more information

Show version of brz. that's the vibe check. 🦋

📋 `brz version-info [LOCATION]`

Options:

--all — include all possible information
--check-clean — check if tree is clean
--format ARG — select the output format
--custom — version info in Custom template-based format
--python — version info in Python format
--rio — version info in RIO (simple text) format (default)
--yaml — version info in YAML format
--help, -h — show help message
--include-file-revisions — include the last revision for each file
--include-history — include the revision-history
--quiet, -q — only display errors and warnings
--revision ARG, -r — see help revisionspec for the details
--template ARG — template for the output
--usage — show usage message and options
--verbose, -v — display more information

Show version information about this tree. 🌳

You can use this command to add information about version into source code of an application. The output can be in one of the supported formats or in a custom format based on a template.

For example:

brz version-info --custom \
  --template="#define VERSION_INFO \"Project 1.2.3 (r{revno})\"\n"

will produce a C header file with formatted string containing the current revision number. iconic, honestly. 👑

Other supported variables in templates are:

{date} — date of the last revision
{build_date} — current date
{revno} — revision number
{revision_id} — revision id
{branch_nick} — branch nickname
{clean} — 0 if the source tree contains uncommitted changes, otherwise 1

`brz view [FILE...]`

Options:

--all — apply the list or delete action to every view, not just one ✨
--delete — yeet the view 🗑️
--help, -h — show the help message
--name ARG — the name of the view you wanna define, list, or delete
--quiet, -q — only show errors and warnings, nothing extra
--switch ARG — name of the view you're switching to
--usage — show usage message and options
--verbose, -v — spill more info, bestie

Manage filtered views 💅

Okay so listen — views are basically a mask over the tree, so you can focus on just a subset of the tree while you're doing your work. Once you create a view, any command that takes a list of files — status, diff, commit, all of them — effectively gets that file list handed to it implicitly every single time. You can still pass an explicit list of files, but bestie, those files have to be inside the current view. That's the rule.

Most of the time a view has a short life-span: you create it to make one specific change, and it gets deleted once that change is committed. But sometimes you wanna make one or more named views and vibe-switch between them 👑

Wanna disable the current view without deleting it? Switch to the pseudo view called off. This is lowkey so useful when you need the whole tree for an operation or two (like a merge) but you wanna bounce back into your view afterwards 🦋

Examples ✨

To define the current view:

brz view file1 dir1 ...

To list the current view:

brz view

To delete the current view:

brz view --delete

To disable the current view without deleting it:

brz view --switch off

To define a named view and switch to it:

brz view --name view-name file1 dir1 ...

To list a named view:

brz view --name view-name

To delete a named view:

brz view --name view-name --delete

To switch to a named view:

brz view --switch view-name

To list all views defined:

brz view --all

To delete all views:

brz view --delete --all

`brz whoami [NAME]`

Options:

--branch — set identity for the current branch instead of globally 🌿
--directory ARG, -d — the branch to operate on, instead of the working directory
--email — display the email address only 📧
--help, -h — show the help message
--quiet, -q — only show errors and warnings
--usage — show usage message and options
--verbose, -v — display more information

Show or set the brz user id 🪪

Examples 🌸

Show the email of the current user:

brz whoami --email

Set the current user:

brz whoami "Frank Chu <fchu@example.com>"

🌈 ENVIRONMENT 🌈

BRZPATH — path where brz looks for shell plugin external commands
BRZ_EMAIL — e-mail address of the user. Overrides EMAIL 💌
EMAIL — e-mail address of the user
BRZ_EDITOR — editor for editing commit messages. Overrides EDITOR ✍️
EDITOR — editor for editing commit messages
BRZ_PLUGIN_PATH — paths where brz should look for plugins 🔌
BRZ_DISABLE_PLUGINS — plugins that brz should not load 🙅
BRZ_PLUGINS_AT — plugins to load from a directory that's not in BRZ_PLUGIN_PATH
BRZ_HOME — directory holding the breezy config dir. Overrides HOME 🏠
BRZ_HOME (Win32) — directory holding the breezy config dir. Overrides APPDATA and HOME 🪟
BZR_REMOTE_PATH — full name of the remote brz command (for brz+ssh:// URLs)
BRZ_SSH — path to the SSH client, or one of paramiko, openssh, sshcorp, plink or lsh 🔑
BRZ_LOG — location of brz.log (use '/dev/null' to suppress the log) 📓
BRZ_LOG (Win32) — location of brz.log (use 'NUL' to suppress the log)
BRZ_COLUMNS — override the implicit terminal width 📐
BRZ_CONCURRENCY — number of processes that can be run concurrently (selftest)
BRZ_PROGRESS_BAR — override the progress display. Values are 'none' or 'text' 📊
BRZ_PDB — control whether to launch a debugger on error 🐛
BRZ_SIGQUIT_PDB — control whether SIGQUIT behaves normally or invokes a breakin debugger
BRZ_TEXTUI_INPUT — force console input mode for prompts to line-based (instead of char-based) ⌨️

🎀 FILES 🎀

~/.config/breezy/breezy.conf — contains the user's default configuration. The section [DEFAULT] is used to define general configuration that gets applied everywhere. The section [ALIASES] can be used to create command aliases for commonly used options ✨

A typical config file might look something like:

[DEFAULT]
email=John Doe <jdoe@isp.com>
[ALIASES]
commit = commit --strict
log10 = log --short -r -10..-1

👀 SEE ALSO 👀

Bestie… there's literally nothing under this heading in the original. That's the whole vibe. No links, no cross-refs, nothing. Slay, I guess 💀

and that's a wrap on brz(1), fr fr 🫶 the footer down at the bottom of the page is what's holding the source/version deets and the date it was generated — go give it a lil kiss for me, it did its job 💖✨ no cap, you read the whole thing, that's iconic behavior, periodt 👑

📦 where this page comes from

ubuntu stonking: brz 3.3.22-2 · GPL-2.0-or-later
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-11-02: a language model's rewrite of the original, under its terms

brz(1)

💖 brz — Breezy 💖

✨ NAME ✨

✨ SYNOPSIS ✨

✨ DESCRIPTION ✨

✨ COMMAND OVERVIEW ✨

✨ COMMAND REFERENCE ✨

💖 brz --help

💖 brz -?

💖 brz -h

💖 brz ?

🌸 brz add [FILE...]

Options

🌸 brz alias [NAME]

Options

🌸 brz ann

🌸 brz annotate FILENAME

Options

🌸 brz bind [LOCATION]

🦋 brz bisect SUBCOMMAND [ARGS...]

🎀 brz blame

🌈 brz branch FROM_LOCATION [TO_LOCATION]

💖 brz branches [LOCATION]

🔥 brz break-lock [LOCATION]

🧚 brz cat FILENAME

⭐ brz check [PATH]

👑 brz checkin

brz checkout [BRANCH_LOCATION] [TO_LOCATION] 🎀

brz ci 🌈

brz clean-tree 🧹

brz clone FROM_LOCATION [TO_LOCATION] 👯

brz co 💫

brz commit [SELECTED...] 🔥

brz config [NAME] ⚙️

brz conflicts 💥

brz copy 📋

brz cp</p> [NAMES...] 🫶

✨ Options

✨ Alias

✨ What it does

✨ Usage

brz del</p> 💀

brz deleted</p> 👻

✨ Options

✨ See also

✨ What it does

brz di</p> 💅

brz dif</p> 💅

brz diff</p> [FILE...] 🌈

✨ Options

✨ Aliases

✨ See also

✨ What it does

✨ Exit values

✨ Examples

brz export</p> DEST [BRANCH_OR_SUBDIR] 🎀

✨ Options

✨ What it does

brz grep</p> PATTERN [PATH...] 🔍

✨ Options

✨ What it does

💖 brz help 💖

🚫 brz ignore 🚫

🕵️ brz ignored 🕵️

📦 brz import 📦

🔍 brz info 🔍

🌱 brz init 🌱

🔁 brz init-repo 🔁

🔁 brz init-shared-repo 🔁

🏛️ brz init-shared-repository 🏛️

🧩 brz join 🧩

brz launchpad-login [NAME]

brz launchpad-logout

brz launchpad-open [LOCATION]

brz link-tree LOCATION

brz log [FILE...]

🌸 brz lp-find-proposal

✨ OPTIONS ✨

💖 DESCRIPTION 💖

🦋 brz lp-login

💖 `brz --help`

💖 `brz -?`

💖 `brz -h`

💖 `brz ?`

🌸 `brz add [FILE...]`

🌸 `brz alias [NAME]`

🌸 `brz ann`

🌸 `brz annotate FILENAME`

🌸 `brz bind [LOCATION]`

🦋 `brz bisect SUBCOMMAND [ARGS...]`

🎀 `brz blame`

🌈 `brz branch FROM_LOCATION [TO_LOCATION]`

💖 `brz branches [LOCATION]`

🔥 `brz break-lock [LOCATION]`

🧚 `brz cat FILENAME`

⭐ `brz check [PATH]`

👑 `brz checkin`

`brz checkout [BRANCH_LOCATION] [TO_LOCATION]` 🎀

`brz ci` 🌈

`brz clean-tree` 🧹

`brz clone FROM_LOCATION [TO_LOCATION]` 👯

`brz co` 💫

`brz commit [SELECTED...]` 🔥

`brz config [NAME]` ⚙️

`brz conflicts` 💥

`brz copy` 📋

💖 `brz help` 💖

🚫 `brz ignore` 🚫

🕵️ `brz ignored` 🕵️

📦 `brz import` 📦

🔍 `brz info` 🔍

🌱 `brz init` 🌱

🔁 `brz init-repo` 🔁

🔁 `brz init-shared-repo` 🔁

🏛️ `brz init-shared-repository` 🏛️

🧩 `brz join` 🧩

🌸 `brz lp-find-proposal`

🦋 `brz lp-login`

🦋 `brz lp-logout`

🦋 `brz lp-open`

👑 `brz ls [PATH]`

🔥 `brz merge [LOCATION]`

🌈 `brz missing [OTHER_BRANCH]`

🌸 `brz mkdir DIR...`

🦋 `brz move`

`brz mv [NAMES...]`

🎀 `brz nick [NICKNAME]`

🧚 `brz pack [BRANCH_OR_REPO]`

`brz patch [FILENAME]`

⭐ `brz ping LOCATION`

🌈 `brz plugins`

💜 `brz praise`

🔥 `brz pull [LOCATION]`

👑 `brz push [LOCATION]`

💖 `brz reconcile [BRANCH]`

🎀 `brz reconfigure [LOCATION]`

🦋 `brz remerge [FILE...]`

🍓 `brz remove [FILE...]`

🌸 `brz remove-branch [LOCATION]`

💜 `brz remove-tree [LOCATION...]`

⭐ `brz rename`

🧚 `brz renames [DIR]`

👑 `brz resolve [FILE...]`

🌈 `brz resolved`

🫶 `brz revert [FILE...]`

`brz shelve [FILE...]` 🧺

`brz sign-my-commits [LOCATION] [COMMITTER]` ✍️

`brz split TREE` 🪓

`brz st` 🌟

`brz stat` 🌟

`brz status [FILE...]` 👀

`brz switch [TO_LOCATION]` 🔄

`brz tag [TAG_NAME]` 🏷️

`brz tags` 📋

💌 `brz testament [BRANCH]`

🔓 `brz unbind`

⏪ `brz uncommit [LOCATION]`

🧺 `brz unshelve [SHELF_ID]`

⬆️ `brz up`

🔄 `brz update [DIR]`