Skip to content

Replace cli commands with npx #104

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

Open
jimlambie wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Replace cli commands with npx #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 2 additions & 8 deletions docs/api/4.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,6 @@ DADI follows the Node.js LTS (Long Term Support) release schedule, and as such t

The easiest way to install API is using DADI CLI. CLI is a command line application that can be used to create and maintain installations of DADI products. Follow the simple instructions below, or see [more detailed documentation for DADI CLI](/cli).

### Install DADI CLI

```console
$ npm install @dadi/cli -g
```

### Create new API installation

There are two ways to create a new API with the CLI: either manually create a new directory for API or let CLI handle that for you. DADI CLI accepts an argument for `project-name` which it uses to create a directory for the installation.
Expand All @@ -37,7 +31,7 @@ $ dadi api new
*Automatic directory creation*

```console
$ dadi api new my-api
$ npx dadi-cli api new my-api
$ cd my-api
```

Expand All @@ -49,7 +43,7 @@ DADI CLI will install the latest version of API and copy a set of files to your

> ```console
> $ cd my-existing-node-app
> $ npm install --save @dadi/api
> $ npm install @dadi/api
> ```
> -- advice

Expand Down
10 changes: 2 additions & 8 deletions docs/cdn/3.2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,6 @@ latest: true

The easiest way to install CDN is using DADI CLI. CLI is a command line application that can be used to create and maintain installations of DADI products. Follow the simple instructions below, or see [more detailed documentation for DADI CLI](/cli).

### Install DADI CLI

```console
$ npm install @dadi/cli -g
```

### Create new CDN installation

There are two ways to create a new CDN with the CLI: either manually create a new directory for CDN or let CLI handle that for you. DADI CLI accepts an argument for `project-name` which it uses to create a directory for the installation.
Expand All @@ -31,7 +25,7 @@ $ dadi cdn new
*Automatic directory creation*

```console
$ dadi cdn new my-cdn
$ npx dadi-cli cdn new my-cdn
$ cd my-cdn
```

Expand All @@ -42,7 +36,7 @@ DADI CLI will install the latest version of CDN and copy a set of files to your
> All DADI platform microservices are also available from [NPM](https://www.npmjs.com/). To add *CDN* to an existing project as a dependency:
> ```console
> $ cd my-existing-node-app
> $ npm install --save @dadi/cdn
> $ npm install @dadi/cdn
> ```
> -- advice

Expand Down
54 changes: 27 additions & 27 deletions docs/cli/2.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ npm install @dadi/cli -g --unsafe-perm

## Usage

Running `dadi help` displays a usage summary:
Running `npx dadi-cli help` displays a usage summary:

```sh

Expand All @@ -57,33 +57,33 @@ Running `dadi help` displays a usage summary:


> API
dadi api clients:add Creates a new client
dadi api new Creates a new instance of DADI
npx dadi-cli api clients:add Creates a new client
npx dadi-cli api new Creates a new instance of DADI
API


> CDN
dadi cdn new Creates a new instance of DADI
npx dadi-cli cdn new Creates a new instance of DADI
CDN
dadi cdn setup Launches an interactive setup
npx dadi-cli cdn setup Launches an interactive setup
wizard


> Web
dadi web routes:list Lists initialised routes
dadi web new Creates a new instance of DADI
npx dadi-cli web routes:list Lists initialised routes
npx dadi-cli web new Creates a new instance of DADI
Web

--

Type dadi help <command> to learn more about a specific command.
Type npx dadi-cli help <command> to learn more about a specific command.
```

Commands begin with the name of the DADI application they apply to. For example, `dadi api new` will install a new instance of API, whilst its CDN counterpart is `dadi cdn new`.
Commands begin with the name of the DADI application they apply to. For example, `npx dadi-cli api new` will install a new instance of API, whilst its CDN counterpart is `npx dadi-cli cdn new`.

### API commands

Running `dadi help api` will show a list of all the API-related commands:
Running `npx dadi-cli help api` will show a list of all the API-related commands:

```sh

Expand All @@ -94,7 +94,7 @@ Running `dadi help api` will show a list of all the API-related commands:
▓▓▓▓▓▓▓


$ dadi api <command>
$ npx dadi-cli api <command>


Available commands:
Expand All @@ -105,12 +105,12 @@ new Creates a new instance of DADI

--

Type dadi help api <command> to learn more about a specific command.
Type npx dadi-cli help api <command> to learn more about a specific command.
```

#### `api clients:add`

Running `dadi help api clients:add` will show the following details for the command:
Running `npx dadi-cli help api clients:add` will show the following details for the command:

```sh

Expand All @@ -121,7 +121,7 @@ Running `dadi help api clients:add` will show the following details for the comm
▓▓▓▓▓▓▓


$ dadi api clients:add --id --secret
$ npx dadi-cli api clients:add --id --secret

Creates a new client

Expand All @@ -136,7 +136,7 @@ This command will create a new oAuth client. It requires two parameters: the cli

#### `api new`

Running `dadi help api new` will show the following details for the command:
Running `npx dadi-cli help api new` will show the following details for the command:

```sh

Expand All @@ -147,7 +147,7 @@ Running `dadi help api new` will show the following details for the command:
▓▓▓▓▓▓▓


$ dadi api new <name> --version
$ npx dadi-cli api new <name> --version

Creates a new instance of DADI API

Expand Down Expand Up @@ -177,7 +177,7 @@ If the `version` parameter is supplied, its value defines the version of CDN tha

### CDN commands

Running `dadi help api` will show a list of all the API-related commands:
Running `npx dadi-cli help api` will show a list of all the API-related commands:

```sh

Expand All @@ -188,7 +188,7 @@ Running `dadi help api` will show a list of all the API-related commands:
▓▓▓▓▓▓▓


$ dadi cdn <command>
$ npx dadi-cli cdn <command>


Available commands:
Expand All @@ -200,13 +200,13 @@ setup Launches an interactive setup

--

Type dadi help cdn <command> to learn more about a specific command.
Type npx dadi-cli help cdn <command> to learn more about a specific command.

```

#### `cdn new`

Running `dadi help cdn new` will show the following details for the command:
Running `npx dadi-cli help cdn new` will show the following details for the command:

```sh

Expand All @@ -217,7 +217,7 @@ Running `dadi help cdn new` will show the following details for the command:
▓▓▓▓▓▓▓


$ dadi cdn new <name> --skip-setup --version
$ npx dadi-cli cdn new <name> --skip-setup --version

Creates a new instance of DADI CDN

Expand Down Expand Up @@ -276,7 +276,7 @@ Time to configure the sources that CDN will use to retrieve images. (18% complet

### Web commands

Running `dadi help web` will show a list of all the API-related commands:
Running `npx dadi-cli help web` will show a list of all the API-related commands:

```sh

Expand All @@ -287,7 +287,7 @@ Running `dadi help web` will show a list of all the API-related commands:
▓▓▓▓▓▓▓


$ dadi web <command>
$ npx dadi-cli web <command>


Available commands:
Expand All @@ -297,13 +297,13 @@ new Creates a new instance of DADI

--

Type dadi help web <command> to learn more about a specific command.
Type npx dadi-cli help web <command> to learn more about a specific command.

```

#### `web new`

Running `dadi help web new` will show the following details for the command:
Running `npx dadi-cli help web new` will show the following details for the command:

```sh

Expand All @@ -314,7 +314,7 @@ Running `dadi help web new` will show the following details for the command:
▓▓▓▓▓▓▓


$ dadi web new <name> --engine --version
$ npx dadi-cli web new <name> --engine --version

Creates a new instance of DADI Web

Expand Down Expand Up @@ -345,7 +345,7 @@ This command also allows users to choose which template engines they’d like to
The following command installs the latest version of Web on a subdirectory called `my-new-website` and installs the Dust.js and Pug.js template engines:

```sh
$ dadi web new my-new-website --engine=@dadi/web-dustjs --engine=@dadi/web-pugjs
$ npx dadi-cli web new my-new-website --engine=@dadi/web-dustjs --engine=@dadi/web-pugjs
```

If this parameter is not supplied, CLI will go into interactive mode and ask the user to choose which engines to install from a list of available engines, pulled from NPM.
Expand Down
9 changes: 1 addition & 8 deletions docs/web/6.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,6 @@ DADI follows the Node.js LTS (Long Term Support) release schedule, and as such t

The easiest way to install Web is using DADI CLI. CLI is a command line application that can be used to create and maintain installations of DADI products.

#### Install DADI CLI

```console
$ npm install @dadi/cli -g
```


#### Create new Web installation

There are two ways to create a new Web application with the CLI: either manually create a new directory for Web or let CLI handle that for you. DADI CLI accepts an argument for `project-name` which it uses to create a directory for installation.
Expand All @@ -42,7 +35,7 @@ $ dadi web new
*Automatic directory creation*

```console
$ dadi web new my-web-app
$ npx dadi-cli web new my-web-app
$ cd my-web-app
```

Expand Down