Prototype of a CLI for Angular applications deployed to Liferay DXP based on the angular-cli project.
The CLI is now in beta. If you wish to collaborate while the project is still young, check out our issue list.
Before submitting new issues, have a look at issues marked with the
type: faq label.
Liferay DXP Support
The server command is replaced with the deploy command. All testing and debugging is performed in a Liferay DXP instance. The webpack compilation is used to create a liferay DXP osgi module. This module is deployed to liferay DXP and is started to make it available for use in the liferay environment.
Both the CLI and generated project have dependencies that require Node 6.9.0 or higher, together with NPM 3 or higher and Liferay DXP FP 11 or higher.
Table of Contents
- Generating a New Project
- Generating Components, Directives, Pipes and Services
- Updating Speedray CLI
- Development Hints for hacking on Speedray CLI
BEFORE YOU INSTALL: please read the prerequisites
npm install -g @speedray/cli
Generating and serving an Angular project via a development server
sr new PROJECT_NAMEcd PROJECT_NAMEsr deploy --watch
http://localhost:8080/. The app will automatically reload if you change any of the source files.
You can configure the default HTTP host and port used by the development server with two command-line options :
sr deploy --host 127.0.0.1 --port 11311
Generating Components, Directives, Pipes and Services
You can use the
sr generate (or just
sr g) command to generate Angular components:
sr generate component my-new-componentsr g component my-new-component # using the alias# components support relative path generation# if in the directory src/app/feature/ and you runsr g component new-cmp# your component will be generated in src/app/feature/new-cmp# but if you were to runsr g component ../newer-cmp# your component will be generated in src/app/newer-cmp
You can find all possible blueprints in the table below:
Updating Speedray CLI
To update Speedray CLI to a new version, you must update both the global package and your project's local package.
npm uninstall -g @speedray/clinpm cache cleannpm install -g @speedray/cli@latest
Local project package:
rm -rf node_modules dist # use rmdir /S/Q node_modules dist in Windows Command Prompt; use rm -r -fo node_modules,dist in Windows PowerShellnpm install --save-dev @speedray/cli@latestnpm install
You can find more details about changes between versions in CHANGELOG.md.
Development Hints for hacking on Speedray CLI
Working with master
git clone https://github.com/ddavis2xtivia/speedray-cli.gitcd speedray-clinpm link
npm link is very similar to
npm install -g except that instead of downloading the package
from the repo, the just cloned
speedray-cli/ folder becomes the global package.
Any changes to the files in the
speedary-cli/ folder will immediately affect the global
allowing you to quickly test any changes you make to the cli project.
Now you can use
@speedray/cli via the command line:
sr new foocd foonpm link @speedray/clisr serve
npm link @speedray/cli is needed because by default the globally installed
@speedray/cli just loads
@speedray/cli from the project which was fetched remotely from npm.
npm link @speedray/cli symlinks the global
@speedray/cli package to the local
speedray-cli you cloned before is in three places:
The folder you cloned it into, npm's folder where it stores global packages and the Speedray CLI project you just created.
You can also use
sr new foo --link-cli to automatically link the
The documentation for the Angular CLI is located in this repo's wiki.