README.rst 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. pwman - Commandline password manager
  2. ====================================
  3. https://bues.ch/h/pwman
  4. pwman is a commandline based password manager. It encrypts the password database file using strong AES-256 encryption.
  5. pwman has support for the following things:
  6. * Store arbitrary attributes and text data along with the passwords and login credentials.
  7. * Generate two factor authentication tokens (`TOTP <https://en.wikipedia.org/wiki/Time-based_One-time_Password_algorithm>`_).
  8. * Database search with Regular Expressions or SQL LIKE syntax.
  9. * Database compare (diff). In pwman prompt, at pwman command line and as `git diff` extension.
  10. * Shell-style Tab-completion for all commands.
  11. * Custom Python scripts for arbitrary database processing.
  12. * Export of the complete database as SQL text dump, CSV dump and human readable plain text dump.
  13. Install pwman
  14. =============
  15. pwman does not have to be installed. The `pwman` script can be run directly from the source tree.
  16. However if you want to install pwman, it can be done either directly from the source tree by running the following commands:
  17. .. code:: sh
  18. ./setup.py build
  19. sudo -i # Or any other command to become root
  20. ./setup.py install
  21. Or it can be installed vi `PyPi <https://pypi.org/>`_ by running the following commands:
  22. .. code:: sh
  23. pip3 install -U pyaes
  24. pip3 install -U pwman-python
  25. Run pwman
  26. =========
  27. Just run the `pwman` executable to start pwman.
  28. Type `pwman -h` for help about the command line options.
  29. pwman prompt
  30. ============
  31. If started without options, pwman enters the command prompt:
  32. .. code::
  33. pwman$
  34. Type the command `help` and press enter to see help about all possible commands.
  35. Command help
  36. ============
  37. To get help about a specific command, enter the command into the prompt and append a question mark without spaces in between:
  38. .. code::
  39. pwman$ find?
  40. Using a custom script to process the database content
  41. =====================================================
  42. A custom Python script can be passed to `pwman` as command line option. Such a script can do anything to the content of the database.
  43. Please see the example script `examplescript.py` for more information.
  44. API documentation
  45. =================
  46. The API documentation can be found in the `API documentation directory <doc/api/>`_.
  47. License / Copyright
  48. ===================
  49. Copyright (c) 2011-2021 Michael Buesch <m@bues.ch>
  50. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
  51. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
  52. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.