# CleverStack CLI A command line interface (CLI) for the [CleverStack](http://cleverstack.io) ecosystem. ## Installation ```npm install cleverstack-cli -g``` ## Quick Setup Tutorial ### Initialize a new project Initializing a new project will download and grab CleverStack's [cleverstack-angular-seed](https://github.com/clevertech/cleverstack-angular-seed) and [cleverstack-node-seed](https://github.com/clevertech/cleverstack-node-seed) seeds. After initializing the project, cleverstack-cli will automatically install any depedencies that are required through [NPM](http://npmjs.org) and [Bower](http://bower.io). `$: clever init my-new-project` You will be asked for database credentials, this is due to the fact that we currently run ```grunt db``` after the initialization. This will soon change, and your database credentials will only be asked for when you install a module that requires it. This will create a new directory called **my-new-project** with two folders: **backend** and **frontend**. `$: cd my-new-project && tree -d -L 1` ``` . ├── backend └── frontend 2 directories ``` ### Installing a module When installing a module, CleverStack will automatically detect: 1. If the module exists 2. If the module is for the frontend or the backend based on it's package.json's keywords. The command is: `$: clever install ` Where **modules** can be: 1. The name of the module as-is (e.g. *clever-background-tasks*) 2. The name of the module without the clever- prefix (e.g. *background-tasks*) 3. The name of the GitHub's username and repo (e.g. *CleverStack/clever-background-tasks*) `$: clever install background-tasks` This will install ```clever-background-tasks``` within the ```backend/modules``` folder. ### Removing a module When removing a module, CleverStack will: 1. Check to see which directory that you're in. If it detects both a backend and a frontend directory then it'll try to remove the module from both seeds. 2. Remain quiet / do nothing if the module does not exist within the module folders (unless there's absolutely nothing to remove). **Note:** The module name must be the exact name as indicated within the folder `$: clever remove clever-background-tasks` ### Running tests ### Aliases tests To ensure that everything is working correctly, you can run tests with: `$: clever test unit` CleverStack will run ```grunt test``` within each seed. ### Running the server ### Aliases: serve `$: clever server` ## Quick Tutorial for Building a New Module There are three commands to be aware of when building a module: 1. generate (or *g*) 2. scaffold (or *s*) 3. new ### generate Generate will create a template of a specific component (controller, services, model, tasks, or tests) within module's name that's residing in your **current working directory.** `$: tree -d -L 1` ``` . 0 directories ``` `$: clever g model my-new-model` `$: tree . -d -L 1` ``` . └── my-new-model 1 directory ``` `$: cd my-new-model && tree . -L 1` ``` . └── models 1 directory, 0 files ``` `$: tree ./models` ``` ./models ├── odm │   └── MyNewModelModel.js └── orm └── MyNewModelModel.js 2 directories, 2 files ``` ### scaffold Scaffolding is similar to generate except it'll generate every component's template for you. **Note:** These files will be generated within your current working directory. `$: tree -d -L 1` ``` . 0 directories ``` `$: clever s my-new-module` `$: tree . -d -L 1` ``` . └── my-new-module ``` `$: tree ./my-new-module -L 3` ``` ./my-new-module ├── config │   └── default.json ├── controllers │   └── MyNewModuleController.js ├── models │   ├── odm │   │   └── MyNewModuleModel.js │   └── orm │   └── MyNewModuleModel.js ├── schema │   └── seedData.json ├── services │   └── MyNewModuleService.js ├── tasks │   └── MyNewModuleTask.js └── tests ├── integration │   └── MyNewModuleTest.js └── unit └── MyNewModuleTest.js 11 directories, 9 files ``` ### new The ```new``` command is similar to ```scaffold``` except it'll create the module within the application's ```module``` folder. `$: tree ./modules -d -L 1` ``` ./modules └── my-new-module 1 directory ``` `$: tree ./modules/my-new-module -L 3 ` ``` ./modules/my-new-module ├── config │   └── default.json ├── controllers │   └── MyNewModuleController.js ├── models │   ├── odm │   │   └── MyNewModuleModel.js │   └── orm │   └── MyNewModuleModel.js ├── schema │   └── seedData.json ├── services │   └── MyNewModuleService.js ├── tasks │   └── MyNewModuleTask.js └── tests ├── integration │   └── MyNewModuleTest.js └── unit └── MyNewModuleTest.js 11 directories, 9 files ``` ### repl In order to interact with your environment's models directly, simply type in: `$: clever repl` ## Commands ### help `$: clever help` ``` Usage: clever [options] Options: -h, --help output usage information -V, --version output the version number Commands: downgrade [-v version] [-p path] - Downgrades a CleverStack implementation help - Displays this help message init [backend|frontend] - Initialized a new project generate