{"id":15062139,"url":"https://github.com/igniteram/protractor-cli","last_synced_at":"2026-04-09T10:47:18.171Z","repository":{"id":57200458,"uuid":"104080566","full_name":"igniteram/protractor-cli","owner":"igniteram","description":":dart: An Interactive command line interface \u0026 config helper for Protractor.js !","archived":false,"fork":false,"pushed_at":"2018-11-09T19:27:05.000Z","size":1757,"stargazers_count":13,"open_issues_count":7,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-30T05:14:52.049Z","etag":null,"topics":["angular","angular-cli","cli","e2e","protractor"],"latest_commit_sha":null,"homepage":"http://npm.im/protractor-cli","language":"TypeScript","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/igniteram.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-19T13:45:45.000Z","updated_at":"2025-01-04T21:48:39.000Z","dependencies_parsed_at":"2022-09-16T15:10:17.141Z","dependency_job_id":null,"html_url":"https://github.com/igniteram/protractor-cli","commit_stats":null,"previous_names":["igniteram/cliptor.js"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igniteram%2Fprotractor-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igniteram%2Fprotractor-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igniteram%2Fprotractor-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igniteram%2Fprotractor-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/igniteram","download_url":"https://codeload.github.com/igniteram/protractor-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248198842,"owners_count":21063626,"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":["angular","angular-cli","cli","e2e","protractor"],"created_at":"2024-09-24T23:31:00.026Z","updated_at":"2026-04-09T10:47:13.144Z","avatar_url":"https://github.com/igniteram.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n\u003cimg src= \"./images/protractor-cli.png\" height=150 alt=\"protractor-cli.png\"/\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n   \u003ci\u003e\u003cstrong\u003eAn Interactive command line interface \u0026 config helper for ProtractorJS\u003c/strong\u003e\u003c/i\u003e\n\u003cp\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://circleci.com/gh/igniteram/protractor-cli/tree/master\"\u003e\u003cimg alt=\"circleCI Status\" src=\"https://circleci.com/gh/igniteram/protractor-cli/tree/master.svg?style=shield\"\u003e\u003c/a\u003e\n\u003ca href=\"http://commitizen.github.io/cz-cli/\"\u003e\u003cimg alt=\"commitizen\" src=\"https://img.shields.io/badge/commitizen-friendly-brightgreen.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://david-dm.org/igniteram/protractor-cli\"\u003e\u003cimg alt=\"dependencies status\" src=\"https://david-dm.org/igniteram/protractor-cli/status.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://badge.fury.io/js/protractor-cli\"\u003e\u003cimg src=\"https://badge.fury.io/js/protractor-cli.svg\" alt=\"npm version\" height=\"18\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/facebook/jest\"\u003e\u003cimg alt=\"JEST\" src=\"https://img.shields.io/badge/tested_with-jest-99424f.svg\"\u003e\u003c/a\u003e\n\u003ca href=#contributors\u003e\u003cimg alt=\"contributors\" src=\"https://img.shields.io/badge/all_contributors-2-orange.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\u003cimg alt=\"MIT License\" src=\"https://img.shields.io/dub/l/vibe-d.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n### \u003cp align=\"center\"\u003e [About](#about) **|** [To Get Started](#to-get-started) **|** [Installation](#installation) **|** [Commands](#commands) \u003c/p\u003e\n\n## About\n\nProtractor-CLI(formerly Cliptor.js) is an interactive command line interface which helps in setting up hassle free protractor projects. It takes user's inputs for generating protractor config files and also downloads the dependencies needed for writing e2e tests.\n\n\u003cp\u003e\n  \u003cimg src=\"./images/cliptor.gif\" alt=\"cliptor.gif\"/\u003e\n\u003c/p\u003e\n\n### What protractor-cli is trying to solve?\n\nSince protractor supports multiple frameworks and has many functionalities associated with them , users face it quite challenging to know the config options and experience a hard time to choose the right library to use in their e2e projects. \n\nThis project focuses primarily to solve these issues by generating config files based on user's input and downloads the respective dependencies automatically.\n\n## To Get Started\n\n#### Pre-requisites\n1.NodeJS installed globally in the system.\nhttps://nodejs.org/en/download/\n\n## Installation\n\nLet's start by installing protractor-cli globally with [npm](https://www.npmjs.com/).\n\n```sh\n$ npm install --global protractor-cli\n```\n## Commands\n\nA global binary **cliptor** will be installed, currently it supports two primary commands - **config** \u0026 **install** with no arguments.\n`cliptor --help` will show these list commands. `cliptor --version` will show the current version of cliptor. \n\n### config\n\n```sh\n$ cliptor config\n```\nStarts protractor's interactive cli, generates config files \u0026 downloads protractor related dependencies!\n\n### install\n\n```sh\n$ cliptor install\n```\nThis installs protractor \u0026 webdriver-manager globally, it also updates webdriver-manager which downloads **chrome**, **firefox** \u0026 **internet explorer** drivers. One can skip this step and use the `cliptor config` command if they want to run selenium server in other ways!\n\n## Library Support\n\nProtractor-CLI supports all the major libraries and frameworks that **Protractor** currently supports, let us have a look-\n\n### Test Frameworks\n\n\u003ca href=\"https://jasmine.github.io/\"\u003e\u003cimg style=\"padding:0px 10px;\" src=\"./images/jasmine.png\" height=60\u003e\u003c/a\u003e\n\u003ca href=\"https://mochajs.org/\"\u003e\u003cimg style=\"padding:0px 10px;\" src=\"./images/mocha.svg\" height=60\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/cucumber/cucumber-js\"\u003e\u003cimg style=\"padding:0px 10px;\" src=\"./images/cucumberjs.png\" height=60\u003e\u003c/a\u003e\n\nJasmine being the default framework. Mocha \u0026 Cucumber have good support as well!\n\n### Transpilers\n\n\u003cdiv\u003e\n\u003cimg style=\"padding:0px 10px;\" src=\"./images/typescript.png\" height=60\u003e\n\u003cimg src=\"./images/coffeeScript.png\" height=70\u003e\n\u003c/div\u003e\n\n\nSince this project has been entirely written using [TypeScript](https://www.typescriptlang.org/). You would find extensive support for it. Protractor also has recently migrated to typescript.\n\nYou could use the typescript features by simply selecting your specific framework \u0026 transpiler option provided by protractor-cli. \n\nJasmine being the default framework , protractor-cli asks whether you would want to use typescript as a transpiler which then installs **typescript**, **jasmine types** and also generates **tsconfig.json** automatically!\n\n[Coffee-Script](http://coffeescript.org/) support has also been provided with **mocha** \u0026 **cucumber** frameworks. You could write your scripts using coffee-script and the above frameworks will auto-compile them. The best part is you don't have to do it manaully as protractor-cli does it for you!\n\n### Browser Configuration\n\nProtractor-CLI supports all three major browser configuration -\n\n\u003cdiv class=\"images\" \u003e\n\u003cimg style=\"float:right margin:0px 10px;\" src=\"./images/chrome.png\" height=50\u003e\n\u003cimg style=\"padding:0px 10px;\" src=\"./images/firefox.jpg\" height=50\u003e\n\u003cimg src=\"./images/IE.jpg\" height=50\u003e\n\u003c/div\u003e\n\n### Test Environments\n\n* **Local Machine** - It is your local test development environment\n* **Cloud Service** - If you want to develop and maintain your test scripts in cloud services like - **Sauce Labs** \u0026 **BrowserStack**.\n* **Remote Machine** - If you know the address of a remote machine where selenium server resides you could use this environment configuration.\n\n### Logging\n\nProtractor has 4 types of logging mechanism -\n\n* **info** (default)\n* **warn**\n* **debug**\n* **error**\n\nOne could refer this [StackOverFlow link](https://stackoverflow.com/questions/2031163/when-to-use-the-different-log-levels) to understand what they are and when to use them. Normally you would have to configure these in your config file manually but now protractor-cli does it for you.\n\n### Reports\n\nProtractor-CLI installs \u0026 configures popular \u0026 well maintained report modules which could be integrated with protractor.\n\nFramework | Report Types | Report Module\n---       | ---          | ---          \n| `Jasmine` |\u003cbr\u003e`dot`\u003c/br\u003e\u003cbr\u003e`spec`\u003c/br\u003e  \u003cbr\u003e`json`\u003c/br\u003e\u003cbr\u003e`html`\u003c/br\u003e|\u003cbr\u003eProtractor jasmine's default dot console reporter\u003c/br\u003e\u003cbr\u003e[jasmine-spec-reporter](https://github.com/bcaudan/jasmine-spec-reporter) for flashy console spec reporter\u003c/br\u003e\u003cbr\u003eProtractor's `resultJsonOutputFile` config option generates json reports\u003c/br\u003e\u003cbr\u003e[protractor-jasmine2-screenshot-reporter](protractor-jasmine2-screenshot-reporter) for html reports. \u003c/br\u003e\n| `Mocha` |\u003cbr\u003e`dot`\u003c/br\u003e\u003cbr\u003e`spec`\u003c/br\u003e  \u003cbr\u003e`json`\u003c/br\u003e\u003cbr\u003e`html`\u003c/br\u003e|\u003cbr\u003eMocha's default dot console reporter in mochaOpts\u003c/br\u003e\u003cbr\u003eBuilt in spec console reporter \u003c/br\u003e\u003cbr\u003eBuilt in mocha's json reporter\u003c/br\u003e\u003cbr\u003e[Mochawesome](https://github.com/adamgruber/mochawesome) for html reports.\n| `cucumber` |\u003cbr\u003e`progress`\u003c/br\u003e\u003cbr\u003e`summary`\u003c/br\u003e  \u003cbr\u003e`json`\u003c/br\u003e\u003cbr\u003e`html`\u003c/br\u003e|\u003cbr\u003eCucumber's default progress console reporter\u003c/br\u003e\u003cbr\u003eSummary console reporter\u003c/br\u003e\u003cbr\u003eJson reporter which generates cucumber json reports\u003c/br\u003e\u003cbr\u003e[cucumber-html-reporter](https://github.com/gkushang/cucumber-html-reporter) for html reports.\n\n### Contributions\n\nFor contributors who want to improve this repo by contributing some code, reporting bugs, issues or improving documentation - PR's are highly welcome, please maintain the coding style , folder structure , detailed description of documentation and bugs/issues with examples if possible.\n\n#### Development Hints\n\nPlease see [DEVELOPER.md](https://github.com/igniteram/protractor-cli/blob/master/DEVELOPER.md)\n\n### Attributions\n\nProtractor-CLI was mainly inspired by [WebdriverIO’s](https://github.com/webdriverio/webdriverio) cli. I would also like to give credit to the Angular’s Protractor community for creating such a wonderful project which inspired this project development.\n## Contributors\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore --\u003e\n| [\u003cimg src=\"https://avatars1.githubusercontent.com/u/15998104?v=4\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eRam Pasala\u003c/b\u003e\u003c/sub\u003e](https://in.linkedin.com/in/rpasala)\u003cbr /\u003e[💻](https://github.com/igniteram/protractor-cli/commits?author=igniteram \"Code\") [📖](https://github.com/igniteram/protractor-cli/commits?author=igniteram \"Documentation\") [⚠️](https://github.com/igniteram/protractor-cli/commits?author=igniteram \"Tests\") [🐛](https://github.com/igniteram/protractor-cli/issues?q=author%3Aigniteram \"Bug reports\") | [\u003cimg src=\"https://avatars3.githubusercontent.com/u/1559007?v=4\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eCraig Nishina\u003c/b\u003e\u003c/sub\u003e](https://github.com/cnishina)\u003cbr /\u003e[💻](https://github.com/igniteram/protractor-cli/commits?author=cnishina \"Code\") [🔌](#plugin-cnishina \"Plugin/utility libraries\") |\n| :---: | :---: |\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\nThanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figniteram%2Fprotractor-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Figniteram%2Fprotractor-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figniteram%2Fprotractor-cli/lists"}