From 251a8b5f32ba2b1094d6c243fa3e0f77a5304926 Mon Sep 17 00:00:00 2001 From: Priyansh Garg Date: Mon, 21 Mar 2022 14:51:45 +0530 Subject: [PATCH] Add create-nightwatch docs. --- guide/getting-started/onboarding-cli.md | 64 +++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 guide/getting-started/onboarding-cli.md diff --git a/guide/getting-started/onboarding-cli.md b/guide/getting-started/onboarding-cli.md new file mode 100644 index 00000000..9eefa7c6 --- /dev/null +++ b/guide/getting-started/onboarding-cli.md @@ -0,0 +1,64 @@ +## Nightwatch Onboarding CLI + +#### Overview + +This CLI tool lets you setup Nightwatch.js in your new or existing project, with all the required configs and dependencies, with just one command. + +#### Usage + +All you need to do is, run: + +##### NPM + +If you're in your existing project's root directory: + +
npm init nightwatch
+ +If you want to create a new project: + +
npm init nightwatch path/to/new/projectv
+ + +##### NPX + +If you're in your existing project's root directory: + +
npx create-nightwatch
+ +If you want to create a new project: + +
npx create-nightwatch path/to/new/project
+ +and answer a few questons. We'll setup everything for you based on your preferences. + + +If you'd like to skip all the questions (we'd assume best defualts for you), you can use the above commands with `--yes` or `-y` flag: + +##### NPM + +If you're in your existing project's root directory: + +
npm init nightwatch -- --yes
+# or
+npm init nightwatch -- -y
+ +If you want to create a new project: + +
npm init nightwatch path/to/new/project -- --yes
+# or
+npm init nightwatch path/to/new/project -- -y
+ + +##### NPX + +If you're in your existing project's root directory: + +
npx create-nightwatch --yes
+# or
+npx create-nightwatch -y
+ +If you want to create a new project: + +
npx create-nightwatch path/to/new/project --yes
+# or
+npx create-nightwatch path/to/new/project -y