# An unofficial command line interface for 2FAS
twofas-cli is an unofficial client for [2FAS](https://2fas.com) written in Python that can retrieve 2fa codes stored on your mobile device by
registering itself as a browser extension with 2FAS. Every request this tool makes for a 2FA code needs to be approved on your mobile device, just like with 2FAS' browser extensions. You can use it for scripting automatic logins to services that require a
second factor via TOTPs.
## Installation
Install via pip from PyPi:
```shell
pip install twofas-cli
```
## Usage
In order to use twofas-cli you need to have the 2FAS app installed on your mobile device.
Head over to [2fas.com](https://2fas.com) for instructions and a download link for your app store.
After installing 2fas on your mobile device and PC, register twofas-cli as a browser extension by running:
```shell
twofas-cli register
```
After running this command successfully you should see a directory containing a QR code image called
`qrcode.png`. Open it and scan it using your 2FAS app.
Afterward, you can run `twofas-cli get --help` to see the available options for retrieving 2fa codes or `twofas-cli --help` to see all possible actions.
## Compatibility
twofas-cli should be able to run anywhere its dependencies and Python itself runs, however, it has only been tested so far on MacOS and Linux. It requires a recentish Python 3 version (>= 3.7).
## Contributing
Contributions are welcome. Please use the [Github Page](https://github.com/dspitzer/twofas-cli) to report issues or submit Pull Requests.
Raw data
{
"_id": null,
"home_page": "https://packages.python.org/twofas-cli",
"name": "twofas-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "2fas twofas",
"author": "dspd",
"author_email": "inmost-chimps-0j@icloud.com",
"download_url": "https://files.pythonhosted.org/packages/d1/6d/dfbe158ed24a3a1e8fd0e7f655c11625f3a8469050aa39537a70ed69f608/twofas-cli-0.1.0.tar.gz",
"platform": null,
"description": "# An unofficial command line interface for 2FAS\n\ntwofas-cli is an unofficial client for [2FAS](https://2fas.com) written in Python that can retrieve 2fa codes stored on your mobile device by\nregistering itself as a browser extension with 2FAS. Every request this tool makes for a 2FA code needs to be approved on your mobile device, just like with 2FAS' browser extensions. You can use it for scripting automatic logins to services that require a\nsecond factor via TOTPs.\n\n## Installation\n\nInstall via pip from PyPi:\n\n```shell\npip install twofas-cli\n```\n\n## Usage\n\nIn order to use twofas-cli you need to have the 2FAS app installed on your mobile device.\nHead over to [2fas.com](https://2fas.com) for instructions and a download link for your app store.\n\nAfter installing 2fas on your mobile device and PC, register twofas-cli as a browser extension by running:\n\n```shell\ntwofas-cli register\n```\n\nAfter running this command successfully you should see a directory containing a QR code image called \n`qrcode.png`. Open it and scan it using your 2FAS app.\n\nAfterward, you can run `twofas-cli get --help` to see the available options for retrieving 2fa codes or `twofas-cli --help` to see all possible actions.\n\n## Compatibility\n\ntwofas-cli should be able to run anywhere its dependencies and Python itself runs, however, it has only been tested so far on MacOS and Linux. It requires a recentish Python 3 version (>= 3.7).\n\n## Contributing\n\nContributions are welcome. Please use the [Github Page](https://github.com/dspitzer/twofas-cli) to report issues or submit Pull Requests.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Unofficial CLI tool for 2FAS using the browser extension api",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://packages.python.org/twofas-cli"
},
"split_keywords": [
"2fas",
"twofas"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d71655e304a70175c2b29b795842b629dc71557551cc397422b8a308e7a26340",
"md5": "e8945a1b05e48efc3e962b568b5f6283",
"sha256": "0e2ab83bbd9ee251175679709dfb64a7b682d3ac482dae3c648a2ed4e911d9fb"
},
"downloads": -1,
"filename": "twofas_cli-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e8945a1b05e48efc3e962b568b5f6283",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8159,
"upload_time": "2023-06-04T04:52:35",
"upload_time_iso_8601": "2023-06-04T04:52:35.057986Z",
"url": "https://files.pythonhosted.org/packages/d7/16/55e304a70175c2b29b795842b629dc71557551cc397422b8a308e7a26340/twofas_cli-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d16ddfbe158ed24a3a1e8fd0e7f655c11625f3a8469050aa39537a70ed69f608",
"md5": "395c3327ddf81020dea896c58c09ea26",
"sha256": "93dc4c7e02d40840e3645d14b5462637a8810f8a934a6252f3c0e243413ec968"
},
"downloads": -1,
"filename": "twofas-cli-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "395c3327ddf81020dea896c58c09ea26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 8067,
"upload_time": "2023-06-04T04:52:36",
"upload_time_iso_8601": "2023-06-04T04:52:36.334460Z",
"url": "https://files.pythonhosted.org/packages/d1/6d/dfbe158ed24a3a1e8fd0e7f655c11625f3a8469050aa39537a70ed69f608/twofas-cli-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-04 04:52:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "twofas-cli"
}
JSON