Skip to content

Added CLI disclaimer in documentation #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −0
Open

Added CLI disclaimer in documentation #183

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ We also recommend that implementers read the
`NIST SP 800-63-3: Digital Authentication Guideline <https://pages.nist.gov/800-63-3/>`_ for a high level overview of
authentication best practices.

Disclaimer on Command-Line Interface (CLI) usage
--------------------------------------------------------
PyOTP is **NOT** a command-line interface (CLI). If you are looking for a CLI tool, this is not the right project. PyOTP is a **library** intended for use by other applications that provide a user interface, such as `3ncrypt0rQR <https://github.com/jonmalki/3ncypt0rQR>`_ or `pyotp_cli <https://github.com/jcjveraa/pyotp_cli>`_. While a CLI may be added in the future—see `Pull Request #159 <https://github.com/pyauth/pyotp/pull/159>`_—this is not the current focus of the project.

Quick overview of using One Time Passwords on your phone
--------------------------------------------------------

Expand Down