diff --git a/guide/getting-started/onboarding-cli.md b/guide/getting-started/onboarding-cli.md new file mode 100644 index 00000000..6a6d0e35 --- /dev/null +++ b/guide/getting-started/onboarding-cli.md @@ -0,0 +1,31 @@ +## 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: + +##### 1) If you're in your existing project's root directory: + +
npm init nightwatch
+
+##### 2) If you want to create a new project:
+
+npm init nightwatch path/to/new/project
+
+and answer a few questons. We'll setup everything for you based on your preferences.
+
+#### Generating a new config file
+
+While it's completely safe to run `npm init nightwatch` again in your existing Nightwatch project, if you want to just generate a new config file and install all the required dependencies and nothing else, you can use this tool with the `--generate-config` flag:
+
+##### 1) Generate new config file based on your preferences:
+
+npm init nightwatch -- --generate-config
+
+##### 2) Generate new config file with default configurations:
+
+npm init nightwatch -- --generate-config --yes