docs/cli.rst @ 3a88cfd5c8b7 initial-docs

Command Line Interface
======================

hg-review provides a command line interface. Except for initializing the review
data, starting the web ui, and possibly some scripting, you'll probably want to
use the :doc:`web interface </webui>` for most tasks.

When you enable the hg-review extension Mercurial will gain a new command:
``review``. This command on its own will display review data for a changeset,
but it also has several subcommands detailed below.

You can always get help on a given topic right from the command line with
``hg help review`` or ``hg help review-topic``.

.. _c-review:

``review``
----------

View code review data for a changeset. Usage::

    hg review [-r REV] [-U CONTEXT] [--quiet] [FILE]

Diffs of all changed files will be shown with comments inline.

The line numbers printed are the ones that should be used to add line-level
comments.

Options:

``--unified VALUE``
    The number of lines of context to show for diffs in this changeset
    (default: ``5``).

``--rev VALUE``
    The revision to show (default: ``.``).

``--quiet``
    Do not show diffs -- only show review-level comments and signoffs (default:
    ``false``).

``--verbose``
    Show the short identifier of each comment and signoff, mainly for use with
    the :ref:`edit <c-edit>` subcommand (default: ``false``).

``--debug``
    Show the full identifier of each comment and signoff, mainly for use with
    the :ref:`edit <c-edit>` subcommand (default: ``false``).

.. _c-init:

``--init``
----------

Initialize code review for a repository. Usage::

    hg review --init --remote-path PATH

When run for the first time in a project, it will do two things:

* Create a new repository to hold the review data at ``.hg/review/``.

* Create and ``hg add`` a ``.hgreview`` file in the current repository. You
  will need to commit this file yourself with: ``hg commmit .hgreview -m
  'initialize code review data'``

The ``--remote-path`` option is required and specifies the path where the
canonical code review data for this project will live.  This is the path that
will be cloned when someone else runs ``hg review --init`` on the project.

Options:

``--remote-path VALUE``
    The URL to the public code review data repository.


.. _c-comment:

``--comment``
-------------


.. _c-signoff:

``--signoff``
-------------


.. _c-edit:

``--edit``
----------


.. _c-check:

``--check``
-----------


.. _c-web:

``--web``
---------