CLI user’s guide
This guide offers a high-level overview of pyHanko as a command-line tool.
If you installed pyHanko using
pip, you should be able to invoke pyHanko
pyhanko command, like so:
pyhanko package is on your
PYTHONPATH but the
executable isn’t on your
PATH for whatever reason, you can also invoke the
python -m pyhanko --help
This guide will adopt the former calling convention.
You can run
pyhanko in verbose mode by passing the
before specifying the subcommand to invoke.
pyhanko --verbose <subcommand>
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
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.
should appear after the subcommand to which they apply, but before the next
- Signing PDF files
- Some background on PDF signatures
- Creating signature fields
- Creating simple signatures
- Creating signatures with long lifetimes
- Customising signature appearances
- Validating PDF signatures
- Stamping PDF files
- Configuration options