A prototype of Cypress CLI for quicker project scaffolding
Requires Node version 8 or above with
npx command, assumes you have installed Cypress already with
npm i -D cypress
npx @bahmutov/cly init
Will output something like the following text on success
npx: installed 72 in 6.853s scaffolding new Cypress project ✅ scaffolded "cypress" folder with a single example spec you can configure additional options in cypress.json file see https://on.cypress.io/configuration
Note: if there are Cypress files or folders already, the
cly will stop.
Watch this utility in action in this video
You can scaffold Cypress specs written in TypeScript
npx @bahmutov/cly init --typescript # or equivalent npx @bahmutov/cly init -t
Sometimes you just need a spec file, without any fixtures, support, or plugin files. Use
--bare option to scaffold the minimal
npx @bahmutov/cly init --bare # or equivalent npx @bahmutov/cly init -b
You can specify version to scaffold using
--cv, --cypress-version <version> argument. For example to scaffold for Cypress v4 run
npx @bahmutov/cly init --cv 4
Only the major version will be considered
npx @bahmutov/cly init --cypress-version 3.8.3 ✅ scaffolded "cypress" folder with a single example spec (v3)
Notice that example folders for TypeScript have format
Run this module with environment variable to see verbose logs
Author: Gleb Bahmutov <firstname.lastname@example.org> © 2019
License: MIT - do anything with the code, but don't blame me if it does not work.
Support: if you find any problems with this module, email / tweet / open issue on Github
Copyright (c) 2019 Gleb Bahmutov <email@example.com>
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.