{"id":15144484,"url":"https://github.com/marketsquare/robotframework-sherlock","last_synced_at":"2025-10-23T22:30:36.740Z","repository":{"id":40305589,"uuid":"418144599","full_name":"MarketSquare/robotframework-sherlock","owner":"MarketSquare","description":"Robot Framework code inspector","archived":false,"fork":false,"pushed_at":"2023-08-14T08:07:54.000Z","size":230,"stargazers_count":14,"open_issues_count":16,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-29T22:08:57.207Z","etag":null,"topics":["robotframework"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MarketSquare.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-17T13:43:53.000Z","updated_at":"2024-10-24T07:41:26.000Z","dependencies_parsed_at":"2024-09-16T19:31:04.145Z","dependency_job_id":null,"html_url":"https://github.com/MarketSquare/robotframework-sherlock","commit_stats":null,"previous_names":["bhirsz/robotframework-sherlock"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarketSquare%2Frobotframework-sherlock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarketSquare%2Frobotframework-sherlock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarketSquare%2Frobotframework-sherlock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MarketSquare%2Frobotframework-sherlock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MarketSquare","download_url":"https://codeload.github.com/MarketSquare/robotframework-sherlock/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237890775,"owners_count":19382562,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["robotframework"],"created_at":"2024-09-26T10:41:39.408Z","updated_at":"2025-10-23T22:30:36.377Z","avatar_url":"https://github.com/MarketSquare.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sherlock\nThe tool for analyzing Robot Framework code in terms of not used code, code complexity or performance issues.\n\n\u003e **Note**\n\u003e \n\u003e The tool is in the ***Alpha*** state, which means it may be unstable and should be used at your own risk. Some \n\u003e features may be broken and there are still many things to be developed. If you find anything unexpected, or you have ideas for improvements \n\u003e not listed in GitHub issues, please open an new issue.\n\n## Installation\n\nYou can install the latest version of Sherlock simply by running:\n```commandline\npip install -U robotframework-sherlock\n```\n\nSherlock requires Python 3.8+.\n\n## Usage\n\nSherlock can prepare analysis based on your source code alone. However, it's currently highly recommended to also include\noutput of test execution.\n\nRun Sherlock with:\n```commandline\nsherlock --output \u003cpath to output.xml file\u003e \u003cpath to source code repository\u003e\n```\n\nTo analyze external library/resource use ``--resource`` option:\n```commandline\nsherlock --output output.xml --resource SeleniumLibrary src/\n```\n```commandline\nsherlock --output output.xml --resource external_repository_used_in_tests/ src/\n```\n\n## Reports\nSherlock by default prints the output. You can configure what reports are produced by sherlock using ``--report`` option:\n```commandline\nsherlock --report print\n```\n```commandline\nsherlock --report html\n```\n``--report`` accepts comma separated list of reports:\n```commandline\nsherlock --report print,html,json\n```\n\n## BuiltIn library\n\nTo show analysis of BuiltIn libraries use ``--include-builtin`` flag:\n```commandline\nsherlock --include-builtin src/\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarketsquare%2Frobotframework-sherlock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarketsquare%2Frobotframework-sherlock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarketsquare%2Frobotframework-sherlock/lists"}