The Ember.js command line utility
JavaScript Other
Latest commit 6cc1b72 Jan 19, 2017 @homu homu Auto merge of #6705 - kellyselden:description, r=rwjblue
add description to serve and test environment option

The analogous changes for #6671
Permalink
Failed to load latest commit information.
.github include global npm version Sep 2, 2016
.travis Auto merge of #6584 - ember-cli:allow-experiments-only-on-canary, r=n… Dec 20, 2016
assets/architecture enforce styles, clean up whitespace and extra lines Oct 30, 2015
bin Replace `cookie` with `token`. Dec 31, 2016
blueprints Revert "remove travis sudo check" Jan 16, 2017
dev Merge branch 'beta' Jan 18, 2017
docs ESLint: Enable "no-multi-spaces" rule Jan 4, 2017
lib add description to serve and test environment option Jan 19, 2017
tests add description to serve and test environment option Jan 19, 2017
.codeclimate.yml Add Code Climate config May 23, 2015
.editorconfig enforce styles, clean up whitespace and extra lines Oct 30, 2015
.eslintignore ESLint: Add "no-undef" rule Feb 12, 2016
.eslintrc.js Properly sort the linting rules in the ES6 section. Jan 4, 2017
.gitattributes use eol=lf for windows Jan 13, 2016
.gitignore Update to npm 3 Sep 29, 2016
.npmignore Removing jshint reference in blueprints Jan 12, 2017
.travis.yml Remove support for Node 0.12. Dec 31, 2016
ADDON_HOOKS.md Use secure URLs in docs where possible Oct 17, 2016
ARCHITECTURE.md Removing jshint reference in blueprints Jan 12, 2017
CHANGELOG.md Merge tag 'v2.10.1' into beta Jan 18, 2017
CODE_OF_CONDUCT.md Fix code of conduct markdown formatting Jul 21, 2015
CONTRIBUTING.md Update CONTRIBUTING.md to reference latest Node LTS. Dec 31, 2016
LICENSE [DOC] Update license year Jan 1, 2017
PERF_GUIDE.md Fixes typos in PERF_GUIDE Oct 24, 2016
README.md Use secure URLs in docs where possible Oct 17, 2016
RELEASE.md Auto merge of #6699 - Turbo87:copypasta, r=rwjblue Jan 18, 2017
SOURCEMAPS.md Add a sourcemaps doc Nov 29, 2016
TRANSITION.md Fix typo in transition doc Sep 12, 2015
appveyor.yml AppVeyor: Install NPM 3 Jan 16, 2017
package.json Split serving assets into two different in-repo addons Jan 19, 2017
yarn.lock Update lockfile to use latest allowed versions. Jan 19, 2017

README.md

ember-cli

Latest NPM release TravisCI Build Status AppVeyor Build Status Test Coverage Code Climate

The Ember.js command line utility.

Features

  • Asset build pipeline using Broccoli.js
  • ES6 transpilation using Babel
  • Project structure conventions using ES6 module syntax
  • Development server including live-reload and API proxy
  • File/Project generator using blueprints
  • Unit, Integration and Acceptance test support using Testem
  • Powerful addon system for extensibility

Installation

npm install -g ember-cli

Usage

After installation the ember CLI tool will be available to you. It is the entrypoint for all the functionality mentioned above.

You can call ember <command> --help to find out more about all of the following commands or visit https://ember-cli.com/user-guide/ to read the in-depth documentation.

Create a new project

ember new my-new-app

This will create a new folder my-new-app, initialize a Git project in it, add the basic Ember.js project structure and install any necessary NPM and Bower dependencies.

Create a new addon project

ember addon my-new-addon

This is essentially similar to ember new but will generate the structure for an ember-cli addon instead.

Build the project

ember build

This will create a dist folder and run the build pipeline to generate all the output files in it. You can specify --environment=production to build in production mode, which includes code minification and other optimizations.

Run the development server

ember serve

This will launch a development server that will automatically rebuild your project on file changes and serves the built app at http://localhost:4200/.

Run the test suite

ember test

This command will start the Testem runner, which will run all your tests from the tests folder. This command also supports a --server option which will automatically run tests on file changes.

Generate files

ember generate route foo

This will generate a route named foo. route is an example here and can be replaced by any other available blueprint. Blueprints are provided by ember-cli itself and any of you installed addons. Run ember generate --help to see a list of available blueprints in your project and their options.

Install an ember-cli addon

ember install some-other-addon

This will search NPM for a package named some-other-addon, install it and run any additional install steps defined in the addon.

Community

Development

Start by cloning the Git project to your local hard drive:

git clone https://github.com/ember-cli/ember-cli.git

Link ember to your development version

Running the following command will link the global ember utility to your local development version:

npm link

Note that the global ember CLI utility will automatically relay to any project-local ember-cli installation. If you want to use your development version there instead run the following command from your Ember.js project folder:

npm link ember-cli

Read the official npm-link documentation for more information.

Run the test suite

npm test

will run ESLint and the "fast" subset of the test suite. Run npm run test-all for the full test suite which will currently take quite a few minutes due to heavy IO and network usage.

ember-cli is using Mocha for its internal tests. If you want to run a specific subset of tests have a look at their documentation.

Build the documentation

Use npm run docs to build HTML and JSON documentation with YUIDoc and place it in docs/build/. Please help by improving this documentation.

License

This project is licensed under the MIT License.