Skip to content

Commit

Permalink
Add create-nightwatch docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
garg3133 committed Mar 21, 2022
1 parent d267058 commit 251a8b5
Showing 1 changed file with 64 additions and 0 deletions.
64 changes: 64 additions & 0 deletions guide/getting-started/onboarding-cli.md
Original file line number Diff line number Diff line change
@@ -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:

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

If you want to create a new project:

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


##### NPX

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

<pre><code class="language-bash">npx create-nightwatch</code></pre>

If you want to create a new project:

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

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:

<pre><code class="language-bash">npm init nightwatch -- --yes
# or
npm init nightwatch -- -y</code></pre>

If you want to create a new project:

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


##### NPX

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

<pre><code class="language-bash">npx create-nightwatch --yes
# or
npx create-nightwatch -y</code></pre>

If you want to create a new project:

<pre><code class="language-bash">npx create-nightwatch path/to/new/project --yes
# or
npx create-nightwatch path/to/new/project -y</code></pre>

0 comments on commit 251a8b5

Please sign in to comment.