VB command line interface

usage: vb init [-h]

Create ``.vb`` directory.

optional arguments:
  -h, --help  show this help message and exit
usage: vb checkout [-h] [--existing] [--fg] branch [start_point]

Create branch and working copy at ``.vb/BRANCH``.

positional arguments:
  branch
  start_point     Create branch at this point. Use HEAD instead if not given.

optional arguments:
  -h, --help      show this help message and exit
  --existing, -e  Use existing BRANCH instead of creating the new one.
  --fg            Run ``git remote add -f ...`` at foreground after ``git
                  clone ...`` is finished. Otherwise, these are done at
                  background in parallel.
usage: vb merge [-h] [--reset-to-remote] [--reset branch]
                [--old-branch-format OLD_BRANCH_FORMAT]
                workspace [workspace ...]

Merge branch(es) to the root repository.

positional arguments:
  workspace

optional arguments:
  -h, --help            show this help message and exit
  --reset-to-remote, -R
  --reset branch, -r branch
                        When specified, rest to it.
  --old-branch-format OLD_BRANCH_FORMAT
                        When --reset is specified, old branch is created using
                        this template.
usage: vb delete [-h] branch

Delete branch and corresponding working directory.

positional arguments:
  branch

optional arguments:
  -h, --help  show this help message and exit
usage: vb sync [-h] [--fg] [--force] [workspace [workspace ...]]

Synchronize git DB in root and branches.

1. Run ``git fetch LOCMAIN`` in specified BRANCHes
2. Run ``git push LOCMAIN BRANCH`` [#]_
3. Run ``git relink`` to save disk consumption

.. [#]  If currently checked out branch at LOCMAIN is BRANCH, then
        ``git pull --ff`` is used instead.

positional arguments:
  workspace

optional arguments:
  -h, --help   show this help message and exit
  --fg         Run ``git relink ...`` at foreground after ``git fetch
               LOCMAIN`` is finished. Otherwise, these are done at background
               in parallel.
  --force, -f  Do force push for `.vb/BRANCH`-to-`LOCMAIN` synchronization.
               When this option is specified, branch in LOCMAIN is discarded.

Project Versions

Previous topic

Welcome to VB’s documentation!

Next topic

Usages by example

This Page