<commit_before>[![Version](https://badge.fury.io/js/webgme-cli.svg)](https://www.npmjs.com/package/webgme-cli)
[![Build Status](https://travis-ci.org/webgme/webgme-cli.svg?branch=master)](https://travis-ci.org/webgme/webgme-cli)
[![Code Climate](https://codeclimate.com/github/webgme/webgme-cli/badges/gpa.svg)](https://codeclimate.com/github/webgme/webgme-cli)
[![Stories in Ready](https://badge.waffle.io/webgme/webgme-cli.png?label=ready&title=Ready)](https://waffle.io/webgme/webgme-cli)

# WebGME CLI
The WebGME cli is a tool for managing WebGME apps. Specifically, it provides a command line interface for creating, removing, installing from other WebGME apps, (etc) for various WebGME components (currently addons and plugins are supported).

A "component" in webgme is general term for one of the following:
- [plugin](https://github.com/webgme/webgme/wiki/GME-Plugins)
- [decorator](https://github.com/webgme/webgme/wiki/GME-Decorators)
- [visualizer](https://github.com/webgme/webgme/wiki/GME-Visualizers)
- addon - event driven logic running on the server w/ access to the model
- seed - a project used as a template for new webgme models
- router - express router providing additional REST endpoints
- layout

# Quick Start
WebGME apps require [NodeJS](https://nodejs.org/en/download/) and [MongDB](https://www.mongodb.org/downloads#production) installed on the host system (the server). It is recommended to use [nvm](https://github.com/creationix/nvm) for installing NodeJS.

## Setting up a WebGME app
First install the project with 

```
npm install -g webgme-cli
```

Next, create a new WebGME app:

```
webgme init MyNewProject
```

Navigate to the project folder and install dependencies:

```
cd MyNewProject
webgme start
```

Now, open a browser and navigate to `http://localhost:8888` to get started!

## Creating custom WebGME components
Additional useful commands include
```
webgme new plugin MyNewPlugin
webgme new addon MyNewAddOn

webgme ls

webgme rm MyNewPlugin
webgme rm MyNewAddOn
```

It currently supports adding plugins or addons from npm or github repositories which are either created with this tool or contain a WebGME `config.js` file in the project root:

```
webgme add plugin <plugin> <project>
```

where `<project>` is either `<github user>/<github repo>` or the npm project name.

# FAQ

+ __Tried loading "coreplugins/XXXXGenerator/XXXXGenerator" at xxxxx/src/../node_modules/webgme/src/plugin/coreplugins/...__

    + This usually happens after updating a clone of the webgme-cli and is caused by an outdated version of the webgme. That is, this happens when the webgme-cli has been updated to support a feature that isn't supported in the currently installed webgme dependency. Running `npm update` from the project root should fix it.<commit_msg>Updated readme to use 'import' instead of 'add'<commit_after>[![Version](https://badge.fury.io/js/webgme-cli.svg)](https://www.npmjs.com/package/webgme-cli)
[![Build Status](https://travis-ci.org/webgme/webgme-cli.svg?branch=master)](https://travis-ci.org/webgme/webgme-cli)
[![Code Climate](https://codeclimate.com/github/webgme/webgme-cli/badges/gpa.svg)](https://codeclimate.com/github/webgme/webgme-cli)
[![Stories in Ready](https://badge.waffle.io/webgme/webgme-cli.png?label=ready&title=Ready)](https://waffle.io/webgme/webgme-cli)

# WebGME CLI
The WebGME cli is a tool for managing WebGME apps. Specifically, it provides a command line interface for creating, removing, installing from other WebGME apps, (etc) for various WebGME components (currently addons and plugins are supported).

A "component" in webgme is general term for one of the following:
- [plugin](https://github.com/webgme/webgme/wiki/GME-Plugins)
- [decorator](https://github.com/webgme/webgme/wiki/GME-Decorators)
- [visualizer](https://github.com/webgme/webgme/wiki/GME-Visualizers)
- addon - event driven logic running on the server w/ access to the model
- seed - a project used as a template for new webgme models
- router - express router providing additional REST endpoints
- layout

# Quick Start
WebGME apps require [NodeJS](https://nodejs.org/en/download/) and [MongDB](https://www.mongodb.org/downloads#production) installed on the host system (the server). It is recommended to use [nvm](https://github.com/creationix/nvm) for installing NodeJS.

## Setting up a WebGME app
First install the project with 

```
npm install -g webgme-cli
```

Next, create a new WebGME app:

```
webgme init MyNewProject
```

Navigate to the project folder and install dependencies:

```
cd MyNewProject
webgme start
```

Now, open a browser and navigate to `http://localhost:8888` to get started!

## Creating custom WebGME components
Additional useful commands include
```
webgme new plugin MyNewPlugin
webgme new addon MyNewAddOn

webgme ls

webgme rm MyNewPlugin
webgme rm MyNewAddOn
```

It currently supports adding plugins or addons from npm or github repositories which are either created with this tool or contain a WebGME `config.js` file in the project root:

```
webgme import plugin <plugin> <project>
```

where `<project>` is either `<github user>/<github repo>` or the npm project name.

# FAQ

+ __Tried loading "coreplugins/XXXXGenerator/XXXXGenerator" at xxxxx/src/../node_modules/webgme/src/plugin/coreplugins/...__

    + This usually happens after updating a clone of the webgme-cli and is caused by an outdated version of the webgme. That is, this happens when the webgme-cli has been updated to support a feature that isn't supported in the currently installed webgme dependency. Running `npm update` from the project root should fix it.
{'fraction_non_alphanumeric': 0.11124933357028612, 'fraction_numerical': 0.0014217167229429537, 'mean_word_length': 4.754601226993865, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 28, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4832754', 'n_tokens_mistral': 1848, 'n_tokens_neox': 1753, 'n_words': 590}