mirror of
https://github.com/zrepl/zrepl.git
synced 2024-11-24 17:35:01 +01:00
docs: small usage section mentioning CLI
This commit is contained in:
parent
e6554b77c0
commit
7ac2821147
@ -82,6 +82,7 @@ Table of Contents
|
||||
tutorial
|
||||
installation
|
||||
configuration
|
||||
usage
|
||||
implementation
|
||||
changelog
|
||||
GitHub Repository & Issue Tracker <https://github.com/zrepl/zrepl>
|
||||
|
28
docs/usage.rst
Normal file
28
docs/usage.rst
Normal file
@ -0,0 +1,28 @@
|
||||
*****
|
||||
Usage
|
||||
*****
|
||||
|
||||
============
|
||||
CLI Overview
|
||||
============
|
||||
|
||||
.. NOTE::
|
||||
|
||||
To avoid duplication, the zrepl binary is self-documenting:
|
||||
invoke any subcommand at any level with the ``--help`` flag to get information on the subcommand, available flags, etc.
|
||||
|
||||
.. list-table::
|
||||
:widths: 30 70
|
||||
:header-rows: 1
|
||||
|
||||
* - Subcommand
|
||||
- Description
|
||||
* - ``zrepl daemon``
|
||||
- run the daemon, required for all zrepl functionality
|
||||
* - ``zrepl control``
|
||||
- control / query the daemon
|
||||
* - ``zrepl control status``
|
||||
- show job activity / monitoring (``--format raw``)
|
||||
* - ``zrepl stdinserver``
|
||||
- see :ref:`transport-ssh+stdinserver`
|
||||
|
Loading…
Reference in New Issue
Block a user