@aofl/aofljs-cli/README.md

# @aofl/aofljs-cli
aofljs-cli is a command line tool for running aofljs/0.5.0 local server and automate the
build process of aofljs apps.

---
## Installation
1. Make sure you have the latest stable versions of git, node and npm installed
2. Install as global package:

```
$ npm install -g @aofl/aofljs-cli
```

---
## Usage
```
  $ aofljs-cli [options]
  $ aofljs-cli [command] [options]
```


### Options:
```
    -h, --help     output usage information
    -V, --version  output the version number

  Examples:

    $ aofljs-cli --help
    $ aofljs-cli --version
```

### Commands:
```
    build       runs r.js in a directory containing __build.js file.
    server      start http server
    help [cmd]  display help for [cmd]

  Examples:

    $ aofljs-cli build -r
    $ aofljs-cli server -dl
    $ aofljs-cli help build
```

#### help
```
  Usage: aofljs-cli help [options]

  Options:
    build     output usage information for the build command. Equivalent to aofljs-cli build -h.
    server    output usage information for the server command. Equivalent to aofljs-cli server -h.
```

#### server
aofljs-cli comes with a web server based on [express](https://www.npmjs.com/package/express).
It supports development mode and live reload functionality.

Install [livereload extensions](http://livereload.com/extensions/) in your browser to use this functionality.

```
  Usage: aofljs-cli server [options]

  Options:

    -h, --help         output usage information
    -d, --dev          dev mode, *.js instead of *.min.js
    -H, --host [host]  set hostname
    -l, --livereload   enable livereload. Requires livereload browser extension
    -p, --port [port]  set port

  Examples:

    $ aofljs-cli server
    $ aofljs-cli server -r
    $ aofljs-cli server -d -l -H example.localhost.com -p 3000
```

#### build-app
aofljs-cli build-app will rebuild desired directories into the output directory. 
The following files/directories will be filtered out:
  - .git
  - .spec.js
  - node_modules
  - bower_components
  - karma.conf.js
  - main.karma.js
  - .md

Names may be provided as additional arguments with a config file to filter desired
apps within the config file.

```json
  Usage: aofljs-cli build-app [options]

  Options:

    -h, --help  output usage information
    -c, --config <path> path to config file
    -o, --output <path> path to output directory
  
  Examples:

    $ aofljs-cli build-app
    $ aofljs-cli build-app myDir -o path/to/output/dir 
    $ aofljs-cli build-app -c path/to/config.json
    $ aofljs-cli build-app -c path/to/config.json name_one name_two

  Config format:

    {
      apps: [
        {
          "name": "app_name",
          "src": "dir_to_copy",
          "output": "output_dir"
        }, ...
      ]
    }


```

#### build
aofljs-cli build command runs [requirejs optimizer](http://requirejs.org/docs/optimization.html)
on __build.js file. The recursive option can be used to traverse the subdirectories of the working directory
to optimize all __build.js scripts.

```
  Usage: aofljs-cli build [options]

  Options:

    -h, --help  output usage information
    -r [path]   recursive build. Path is optional and if unspecified PWD will be used.
  
  Examples:

    $ aofljs-cli build
    $ aofljs-cli build -r
    $ aofljs-cli build -r path/to/dir1
    $ aofljs-cli build -r path/to/dir1 path/to/dir2 ptah/to/dir3

```

*note:\**
main.js builds fail in some cases with `Error: /abs/path/to/main.js does not exist.`
To fix this issue update `mainConfigFile` path.
```
  mainConfigFile: './main.js',
to
  mainConfigFile: '../../app-directory/js/main.js',
```

#### translate
aofljs-cli pot translates marked text within html elements that have a translate attribute.

```
  Usage: aofljs-cli pot
  
  Examples:

    $ aofljs-cli pot dir/to/translate

```

## License
The MIT License (MIT)
Copyright (c) 2017 Age of Learning

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.