Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 2.25 KB

README.md

File metadata and controls

38 lines (24 loc) · 2.25 KB

Aurelia CLI

npm Version Join the chat at https://gitter.im/aurelia/discuss Twitter

This library is part of the Aurelia platform and contains its CLI implementation. To keep up to date on Aurelia, please visit and subscribe to the official blog and our email list. We also invite you to follow us on twitter. If you have questions look around our Discourse forums, chat in our community on Gitter or use stack overflow. Documentation can be found in our developer hub.

Documentation

You can read documentation on the cli here. If you would like to help improve this documentation, visit aurelia/documentation.

Contributing

Please see the contributing guidelines.

Providing new feature to app skeleton

For contributors planning to add new features to the skeleton application, please see the descriptive skeleton guide guide.

Building

  1. Clone the aurelia-cli: git clone https://github.com/aurelia/cli.git
  2. Go into the cli directory: cd cli
  3. Run npm install
  4. Run build npm run build
  5. Link the cli with: npm link
  6. Create a new project with au new or use an existing project. The linked CLI will be used to create the project.
  7. In the project directory, run npm link aurelia-cli. The linked CLI will then be used for au commands such as au run

Running the Tests

Run npm test to run the unit tests.

Release new aurelia-cli version

Please see the release instructions.