CLI user’s guide¶
This guide offers a high-level overview of pyHanko as a command-line tool.
(Under construction)
If you installed pyHanko using pip
, you should be able to invoke pyHanko
using the pyhanko
command, like so:
pyhanko --help
If the pyhanko
package is on your PYTHONPATH
buth the pyhanko
executable isn’t on your PATH
for whatever reason, you can also invoke the
CLI through
python -m pyhanko --help
This guide will adopt the former calling convention.
You can run pyhanko
in verbose mode by passing the --verbose
flag
before specifying the subcommand to invoke.
pyhanko --verbose <subcommand>
Note
The CLI portion of pyHanko was implemented using
Click. In particular, this means that
it comes with a built-in help function, which can be accessed through
pyhanko --help
.
Caution
The pyHanko CLI makes heavy use of Click’s subcommand functionality.
Due to the way this works, the precise position of a command-line parameter
sometimes matters. In general, double-dash options (e.g. --option
)
should appear after the subcommand to which they apply, but before the next
one.
Right now, the pyHanko CLI offers two subcommand groups, for sign and stamp, respectively. Additional configuration options are available in an optional YAML config file.