add documentation for basic CLI

libkeepass · Oct 12, 2020 · 6eec7d7 · 6eec7d7
1 parent e271aac
commit 6eec7d7
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 0 deletions.
diff --git a/doc/source/__main__.rst b/doc/source/__main__.rst
@@ -0,0 +1,5 @@
+__main__
+========
+
+.. automodule:: pykeepass.__main__
+   :members:
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -14,6 +14,7 @@ PyKeePass
    exceptions
    baseelement
    kdbx_parsing/*
+   __main__
 
 .. image:: https://travis-ci.org/libkeepass/pykeepass.svg?branch=master
    :target: https://travis-ci.org/libkeepass/pykeepass
@@ -368,6 +369,36 @@ string containing algorithm used to encrypt database.  Possible values are ``aes
 
 create a new database at ``filename`` with supplied credentials.  Returns ``PyKeePass`` object
 
+Console usage (CLI)
+-------------------
+
+PyKeePass allows you to manipulate KeePass database straight from the console
+via simple set of commands:
+
+.. code:: shell
+
+   # display help
+   $ pykeepass --help
+
+   # show all items as a tree in CLI
+   $ pykeepass -p password -f ~/Desktop/mydatabase.kdbx tree
+   [Root]
+   |-- [foobar_group]
+   |   |-- [subgroup/name]
+   |   |   |-- subentry
+   |   |   |-- subentry2
+   |   |   `-- foobar_entry
+   |   |
+   |   |-- group_entry
+   |   `-- foobar_entry
+   |
+   |-- [foobar_group2]
+   |-- [Работа]
+   |   `-- Тест
+   |
+   |-- root_entry
+   `-- test/name
+
 Tests
 -----