Skip to content
This repository has been archived by the owner on Oct 4, 2022. It is now read-only.

Commit

Permalink
Merge pull request #130 from nearform/issue-122
Browse files Browse the repository at this point in the history
Fix CLI command name from starter to init
  • Loading branch information
simoneb committed Sep 4, 2018
2 parents dd188ef + dd082b4 commit 94dec4e
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The quickest way to get started with Titus is to use the CLI to create a starter
You can do this by running:

```
npx @nearform/titus-cli starter <project-name>
npx @nearform/titus-cli init <project-name>
```

This command will generate frontend and backend starter applications.
Expand Down
8 changes: 4 additions & 4 deletions packages/titus-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A command line application to work with Titus

## Features

* `starter` command to initialise a new Titus application.
* `init` command to initialise a new Titus application.
* The ability to choose between a Titus application for the backend, frontend or both.

## Installation
Expand All @@ -16,19 +16,19 @@ npm install -g @nearform/titus-cli
If you'd prefer not to install the package globally you can use [`npx`](https://www.npmjs.com/package/npx) which comes bundled with npm 5.2.0 or later. You can use it like so:

```
npx @nearform/titus-cli starter <project-name>
npx @nearform/titus-cli init <project-name>
```

## Usage

```
titus starter <project-name>
titus init <project-name>
```

Example

```
titus starter my-project
titus init my-project
```

This pulls the latest version of titus starter shell from GitHub and copies it to a new subfolder of the current directory called `my-project/`
Expand Down
3 changes: 3 additions & 0 deletions packages/titus-cli/titus-cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ program
.arguments('<project>')
.action(initAction)

// unknown command passed then show help
program.on('command:*', () => program.help())

program.parse(process.argv)

// no arguments passed then show help
Expand Down

0 comments on commit 94dec4e

Please sign in to comment.