Stencil Command Line Interface

This is unofficial extension to already existing Stencil-CLI which I have found lacking in such features as generating components. In future I will hopefully make a PR with this code to original Stencil's lib.

Installation

Stencil requires a recent LTS version of NodeJS and npm. Make sure you've installed and/or updated Node before continuing.

You can install the Stencil CLI globally with command,

npm i @chbernat/stencil-cli -g

Now the stencil-cli command should be available in your command line tool.

If you want to use it only for generation of your components you can install it as dev dependency (with flag -D).

Usage

Reusable Components

You can create a reusable stencil component or library with command,

stencil-cli start-component my-component

Where my-component is the name you want for the component or library.

This will create a folder with the basics that you need to develop your component.

Building an app

You can build entire apps with Stencil, here is the command to get a starter app for Stencil,

stencil-cli start-app my-app

Where my-app is the name you want for the app.

This will create a folder with the basics that you need to develop your awesome app.

Generating a component

With the following command you can generate a new Stencil component in your exisiting Stencil projects,

stencil-cli generate my-component

Where my-component is the name you want for the new component.

This will create a new folder for the component under src/components, with a css file, unit test spec.ts file and the component tsx file.

Start development server

The following command is simply an alias to npm start that starts the Stencil development server.

stencil-cli start

Wildcard command

If you write any other command after stencil-cli it acts like an alias for a npm run script.

For example stenci-clil build will run the npm run build command.

Contribute

If you see anything that can be improved just let me know or fix it in a pull request. :)

Development

To help develop this tool start with cloning it down to your machine and run npm install.

git clone https://github.com/ChBernat/stencil-cli stencil-cli
cd stencil-cli
npm install

To test your local changes run the following in the stencil-cli folder,

npm link

and now you should be able to run the stencil-cli command anywhere and your changes is reflected instantly.

Author

Many thanks to original author of the repository and code: https://github.com/nerdic-coder/stencil-cli