Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add create-nightwatch docs. #156

Open
wants to merge 3 commits into
base: versions/2.0
Choose a base branch
from
Open

Add create-nightwatch docs. #156

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d4115b2
Add create-nightwatch docs.
garg3133 Mar 21, 2022
860170b
Add new config generation instuctions.
garg3133 Mar 22, 2022
768d78e
Remove --yes section from doc.
garg3133 Apr 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions guide/getting-started/onboarding-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be really cool to have an animated gif that demo's the tool in action, such as the one in the schematics project or this video: https://vimeo.com/376838936


##### 1) If you're in your existing project's root directory:

<pre><code class="language-bash">npm init nightwatch</code></pre>

##### 2) If you want to create a new project:

<pre><code class="language-bash">npm init nightwatch path/to/new/project</code></pre>

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:

<pre><code class="language-bash">npm init nightwatch -- --generate-config</code></pre>

##### 2) Generate new config file with default configurations:

<pre><code class="language-bash">npm init nightwatch -- --generate-config --yes</code></pre>