# Scanerr CLI (command line interface)
This is the CLI repo for the Scanerr API, an error detection service designed to run front-end tests on web applications.
Copyright © Scanerr 2024
### Usage
> Reference <a target="_blank" href="https://docs.scanerr.io/guides/cli.html">Scanerr Docs</a> for usage instructions
---
### Installation
```shell
pip install scanerr
```
### Basic Setup
```shell
scanerr config <api_key>
scanerr check
```
---
## Docker CLI Image
This docker image provides easy access to the CLI and priorities single use commands for simple integration with CI/CD tools
### Usage
```shell
docker run scanerr/cli test-site \
<site-id> \
--min-score 85 \
--max-wait-time 120 \
--api-key <api_key>
```
**For a full list of commands:**
```shell
docker run scanerr/cli --help
```
### LICENSE
```license
The MIT License
Copyright (c) Scanerr.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```
# Support
Please open [issues in Github](https://github.com/Scanerr-io/cli/issues) or send questions to [Scanerr support](mailto:hello@scanerr.io)
Raw data
{
"_id": null,
"home_page": null,
"name": "scanerr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "regression testing, vrt, visual regression testing",
"author": null,
"author_email": "Scanerr <hello@scanerr.io>",
"download_url": "https://files.pythonhosted.org/packages/0a/61/bca2b4e24eafb5bd7e02bbce6e4d33b81783cb7a8edebcc243d71cca3eee/scanerr-0.0.10.tar.gz",
"platform": null,
"description": "# Scanerr CLI (command line interface)\n\n\n\nThis is the CLI repo for the Scanerr API, an error detection service designed to run front-end tests on web applications.\n\nCopyright \u00a9 Scanerr 2024\n\n### Usage\n> Reference <a target=\"_blank\" href=\"https://docs.scanerr.io/guides/cli.html\">Scanerr Docs</a> for usage instructions\n\n---\n\n### Installation\n```shell\npip install scanerr\n```\n\n### Basic Setup\n```shell\nscanerr config <api_key>\nscanerr check\n```\n\n---\n\n## Docker CLI Image\n\nThis docker image provides easy access to the CLI and priorities single use commands for simple integration with CI/CD tools\n\n\n### Usage\n\n```shell\ndocker run scanerr/cli test-site \\ \n <site-id> \\\n --min-score 85 \\\n --max-wait-time 120 \\\n --api-key <api_key> \n```\n\n**For a full list of commands:**\n\n```shell\ndocker run scanerr/cli --help\n```\n\n### LICENSE\n```license\nThe MIT License\n\nCopyright (c) Scanerr.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n```\n\n# Support\nPlease open [issues in Github](https://github.com/Scanerr-io/cli/issues) or send questions to [Scanerr support](mailto:hello@scanerr.io)\n",
"bugtrack_url": null,
"license": null,
"summary": "Official Scanerr CLI",
"version": "0.0.10",
"project_urls": {
"Documentaion": "https://docs.scanerr.io",
"Homepage": "https://github.com/scanerr-io/cli",
"Issues": "https://github.com/scanerr-io/cli/issues"
},
"split_keywords": [
"regression testing",
" vrt",
" visual regression testing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ecf1e4314f12d6aeada721276f733a1a1fdf5b71fd2b453dfa96444a35766e98",
"md5": "b74bcf40c7a3a16b93c4cd1bffeb7e36",
"sha256": "4f14b0061fd426cb34f39633fa987510313496872db43dd89d860181dd940322"
},
"downloads": -1,
"filename": "scanerr-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b74bcf40c7a3a16b93c4cd1bffeb7e36",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 9700,
"upload_time": "2024-07-29T16:04:47",
"upload_time_iso_8601": "2024-07-29T16:04:47.712124Z",
"url": "https://files.pythonhosted.org/packages/ec/f1/e4314f12d6aeada721276f733a1a1fdf5b71fd2b453dfa96444a35766e98/scanerr-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0a61bca2b4e24eafb5bd7e02bbce6e4d33b81783cb7a8edebcc243d71cca3eee",
"md5": "1896d5e6a4474cbf655e498c90c7aa7e",
"sha256": "beaae6fd261dca6039edb0937e778c3627391614b869b64e73ba98ac6d6cc3a8"
},
"downloads": -1,
"filename": "scanerr-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "1896d5e6a4474cbf655e498c90c7aa7e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8490,
"upload_time": "2024-07-29T16:04:48",
"upload_time_iso_8601": "2024-07-29T16:04:48.903685Z",
"url": "https://files.pythonhosted.org/packages/0a/61/bca2b4e24eafb5bd7e02bbce6e4d33b81783cb7a8edebcc243d71cca3eee/scanerr-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-29 16:04:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "scanerr-io",
"github_project": "cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "scanerr"
}
JSON
