{"id":21944799,"url":"https://github.com/browserstack/browserstack-local-ruby","last_synced_at":"2025-10-30T05:06:17.968Z","repository":{"id":4100500,"uuid":"51922935","full_name":"browserstack/browserstack-local-ruby","owner":"browserstack","description":"Ruby bindings for BrowserStack Local","archived":false,"fork":false,"pushed_at":"2024-06-17T06:35:10.000Z","size":73,"stargazers_count":10,"open_issues_count":5,"forks_count":17,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-10-25T02:26:30.711Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.browserstack.com","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/browserstack.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"MIT-LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-02-17T13:03:23.000Z","updated_at":"2024-10-13T22:28:08.000Z","dependencies_parsed_at":"2024-06-18T21:52:52.319Z","dependency_job_id":null,"html_url":"https://github.com/browserstack/browserstack-local-ruby","commit_stats":{"total_commits":77,"total_committers":13,"mean_commits":5.923076923076923,"dds":0.3116883116883117,"last_synced_commit":"c5e8cc947f96d2777d0bd6431ffa985bf76ba73b"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/browserstack/browserstack-local-ruby","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fbrowserstack-local-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fbrowserstack-local-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fbrowserstack-local-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fbrowserstack-local-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/browserstack","download_url":"https://codeload.github.com/browserstack/browserstack-local-ruby/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/browserstack%2Fbrowserstack-local-ruby/sbom","scorecard":{"id":254809,"data":{"date":"2025-08-11","repo":{"name":"github.com/browserstack/browserstack-local-ruby","commit":"80c8d66db4e6a478706f18e90e5c3f76895b4b31"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.5,"checks":[{"name":"Code-Review","score":7,"reason":"Found 10/13 approved changesets -- score normalized to 7","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":2,"reason":"dependency not pinned by hash detected -- score normalized to 2","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/gem-push.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/browserstack/browserstack-local-ruby/gem-push.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/gem-push.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/browserstack/browserstack-local-ruby/gem-push.yml/master?enable=pin","Info:   2 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":9,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'contents' permission set to 'read': .github/workflows/Semgrep.yml:22","Info: jobLevel 'contents' permission set to 'read': .github/workflows/gem-push.yml:10","Info: topLevel 'contents' permission set to 'read': .github/workflows/Semgrep.yml:16","Warn: no topLevel permission defined: .github/workflows/gem-push.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: MIT-LICENSE.txt:0","Info: FSF or OSI recognized license: MIT License: MIT-LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":9,"reason":"1 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-jphg-qwrw-7w9g"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 27 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-17T09:23:21.871Z","repository_id":4100500,"created_at":"2025-08-17T09:23:21.871Z","updated_at":"2025-08-17T09:23:21.871Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281544221,"owners_count":26519553,"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","status":"online","status_checked_at":"2025-10-28T02:00:06.022Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-29T04:17:09.269Z","updated_at":"2025-10-30T05:06:17.951Z","avatar_url":"https://github.com/browserstack.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# browserstack-local-ruby\n\n[![Build Status](https://travis-ci.org/browserstack/browserstack-local-ruby.svg?branch=master)](https://travis-ci.org/browserstack/browserstack-local-ruby) [![Gem Version](https://badge.fury.io/rb/browserstack-local.svg)](https://badge.fury.io/rb/browserstack-local)\n\nRuby bindings for BrowserStack Local.\n\n## Installation\n\n```\ngem install browserstack-local\n```\n\n## Example\n\n```\nrequire 'browserstack/local'\n\n#creates an instance of Local\nbs_local = BrowserStack::Local.new\n\n#replace \u003cbrowserstack-accesskey\u003e with your key. You can also set an environment variable - \"BROWSERSTACK_ACCESS_KEY\".\nbs_local_args = { \"key\" =\u003e \"\u003cbrowserstack-accesskey\u003e\" }\n\n#starts the Local instance with the required arguments\nbs_local.start(bs_local_args)\n\n#check if BrowserStack local instance is running\nputs bs_local.isRunning\n\n#stop the Local instance\nbs_local.stop\n\n```\n\n## Arguments\n\nApart from the key, all other BrowserStack Local modifiers are optional. For the full list of modifiers, refer [BrowserStack Local modifiers](https://www.browserstack.com/local-testing#modifiers). For examples, refer below -  \n\n#### Verbose Logging\nTo enable verbose logging - \n```\nbs_local_args = { \"key\" =\u003e \"\u003cbrowserstack-accesskey\u003e\" , \"v\" =\u003e \"true\"}\n```\n\n#### Folder Testing\nTo test local folder rather internal server, provide path to folder as value of this option - \n```\nbs_local_args = { \"key\" =\u003e \"\u003cbrowserstack-accesskey\u003e\" , \"f\" =\u003e \"/my/awesome/folder\"}\n```\n\n#### Force Start \nTo kill other running Browserstack Local instances - \n```\nbs_local_args = { \"key\" =\u003e \"\u003cbrowserstack-accesskey\u003e\" , \"force\" =\u003e \"true\"}\n```\n\n#### Only Automate\nTo disable local testing for Live and Screenshots, and enable only Automate - \n```\nbs_local_args = { \"key\" =\u003e \"\u003cbrowserstack-accesskey\u003e\" , \"onlyAutomate\" =\u003e \"true\"}\n```\n\n#### Force Local\nTo route all traffic via local(your) machine - \n```\nbs_local_args = { \"key\" =\u003e \"\u003cbrowserstack-accesskey\u003e\" , \"forcelocal\" =\u003e \"true\"}\n```\n\n#### Proxy\nTo use a proxy for local testing -  \n\n* proxyHost: Hostname/IP of proxy, remaining proxy options are ignored if this option is absent\n* proxyPort: Port for the proxy, defaults to 3128 when -proxyHost is used\n* proxyUser: Username for connecting to proxy (Basic Auth Only)\n* proxyPass: Password for USERNAME, will be ignored if USERNAME is empty or not specified\n\n```\nbs_local_args = { \"key\" =\u003e \"\u003cbrowserstack-accesskey\u003e\", \"proxyHost\" =\u003e \"127.0.0.1\", \"proxyPort\" =\u003e \"8000\", \"proxyUser\" =\u003e \"user\", \"proxyPass\" =\u003e \"password\"}\n```\n\n#### Local Proxy\nTo use local proxy in local testing -\n\n* localProxyHost: Hostname/IP of proxy, remaining proxy options are ignored if this option is absent\n* localProxyPort: Port for the proxy, defaults to 8081 when -localProxyHost is used\n* localProxyUser: Username for connecting to proxy (Basic Auth Only)\n* localProxyPass: Password for USERNAME, will be ignored if USERNAME is empty or not specified\n\n```\nbs_local_args = { \"key\" =\u003e \"\u003cbrowserstack-accesskey\u003e\", \"localProxyHost\" =\u003e \"127.0.0.1\", \"localProxyPort\" =\u003e \"8000\", \"-localProxyUser\" =\u003e \"user\", \"-localProxyPass\" =\u003e \"password\"}\n```\n\n#### PAC (Proxy Auto-Configuration)\nTo use PAC (Proxy Auto-Configuration) in local testing -\n\n* pac-file: PAC (Proxy Auto-Configuration) file’s absolute path\n\n```\nbs_local_args = { \"key\" =\u003e \"\u003cbrowserstack-accesskey\u003e\" , \"-pac-file\" =\u003e \"\u003cpac_file_abs_path\u003e\"}\n```\n\n#### Local Identifier\nIf doing simultaneous multiple local testing connections, set this uniquely for different processes - \n```\nbs_local_args = { \"key\" =\u003e \"\u003cbrowserstack-accesskey\u003e\" , \"localIdentifier\" =\u003e \"randomstring\"}\n```\n\n## Additional Arguments\n\n#### Binary Path\n\nBy default, BrowserStack local wrappers try downloading and executing the latest version of BrowserStack binary in ~/.browserstack or the present working directory or the tmp folder by order. But you can override these by passing the -binarypath argument.\nPath to specify local Binary path -\n```\nbs_local_args = { \"key\" =\u003e \"\u003cbrowserstack-accesskey\u003e\" , \"binarypath\" =\u003e \"/browserstack/BrowserStackLocal\"}\n```\n\n#### Logfile\nTo save the logs to the file while running with the '-v' argument, you can specify the path of the file. By default the logs are saved in the local.log file in the present woring directory. \nTo specify the path to file where the logs will be saved - \n```\nbs_local_args = { \"key\" =\u003e \"\u003cbrowserstack-accesskey\u003e\" , \"v\" =\u003e \"true\", \"logfile\" =\u003e \"/browserstack/logs.txt\"}\n```\n\n## Contribute\n\n### Build Instructions\n\nTo build gem, `rake build`.\n\nTo run the test suite run, `rake test`.\n\n### Reporting bugs\n\nYou can submit bug reports either in the Github issue tracker.\n\nBefore submitting an issue please check if there is already an existing issue. If there is, please add any additional information give it a \"+1\" in the comments.\n\nWhen submitting an issue please describe the issue clearly, including how to reproduce the bug, which situations it appears in, what you expect to happen, what actually happens, and what platform (operating system and version) you are using.\n\n### Pull Requests\n\nWe love pull requests! We are very happy to work with you to get your changes merged in, however, please keep the following in mind.\n\n* Adhere to the coding conventions you see in the surrounding code.\n* Include tests, and make sure all tests pass.\n* Before submitting a pull-request, clean up the git history by going over your commits and squashing together minor changes and fixes into the corresponding commits. You can do this using the interactive rebase command.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrowserstack%2Fbrowserstack-local-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrowserstack%2Fbrowserstack-local-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrowserstack%2Fbrowserstack-local-ruby/lists"}