/
README
35 lines (27 loc) · 1.22 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
docopts
=======
Docopts is a shell interpreter for the docopt command line interface description
language, designed to simplify the task of argument parsing in shell scripts.
Installation
------------
Execute the following command in the release directory to install docopts for
all users::
python setup.py install
If you only wish to install docopts for yourself, use::
python setup.py install --user
Running docopts
---------------
Docopts reads a command line interface description from standard input and uses
it to parse the arguments passed to it. If successful, the parsed arguments
are stored in a temporary directory and its location is written to standard
output. Docopts is commonly invoked as follows:
args=$(echo "$help" | docopts "$@")
For details, see the man page.
Notes
-----
The docopts version number always matches that of the docopt Python reference
implementation version against which it was built. As docopt follows semantic
versioning, docopts should work with any docopt release it shares the major
version number with; however, as both docopts and docopt are in major version
number 0 at the moment, docopts can only be relied to work with an installation
of docopt with the exact same version number.