Polymer CLI is the official command line tool for Polymer projects and Web Components. It includes a build pipeline, a boilerplate generator for creating elements and apps, a linter, a development server, and a test runner.
Follow these instructions to install the Polymer CLI on a Linux or MacOS operating system.
For a suggested way to run the Polymer CLI on Windows 10, see the instructions below on Installing Polymer CLI pre-requisites on Windows 10.
Install Polymer CLI
Make sure you have installed a version of Node.js supported by Polymer. To check the version of Node.js that you have installed, run:
See the official node version support policy for more details.
npm install npm@latest -g
Ensure that Git is installed.
If it isn't, you can find it on the Git downloads page.
Install Polymer CLI.
npm install -g polymer-cli
You're all set. Run
polymer help to view a list of commands.
CLI project types
Polymer CLI works with two types of projects:
Elements projects. In an element project, you expose a single element or group of related elements which you intend to use in other element or app projects, or distribute on a registry like NPM. Elements are reusable and organized to be used alongside other elements, so components are referenced outside the project.
See the guide to creating an element project with the Polymer CLI for more information.
Application projects. In an app project, you build an application, composed of Polymer elements, which you intend to deploy as a website. Applications are self-contained, organized with components inside the application.
See the guide to creating an application project with the Polymer CLI for more information.
See the documentation on Polymer CLI commands for a list of commands and how to use them.
Installing Polymer CLI pre-requisites on Windows 10
There are multiple ways to install the pre-requisites for the Polymer CLI on a Windows 10 system. This method uses Bash on the Windows Subsystem for Linux.
For complete and up-to-date installation instructions for Bash on the Windows Subsystem for Linux, we recommend you review the Bash on ubuntu on Windows documentation.
Enable Bash on Windows 10
Check your Windows OS build:
1. Press **Win+R** to open the **Run** dialog. 2. At **Open**, enter `winver`. 3. Click **OK**.
Make sure you have an x64 installation of Windows 10 with OS build > 14393.
Open Settings > Update and Security > For developers and select Developer Mode.
From the Start Menu, search for Turn Windows features on or off and select Windows Subsystem for Linux.
Restart your computer.
Log in as Administrator.
From a PowerShell prompt, run the following command:
Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
When the previous command is complete, open a Bash prompt:
If you are asked to create a new user, follow the prompts to do so.
Your Bash installation is complete. You can start now start a new Bash prompt by typing
the Start menu.
Install Node with nvm
For complete and up-to-date instructions, refer to the official documentation for installing Node with nvm.
Type the following command to use an install script:
curl -o- https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash
Restart your terminal by closing and re-opening your Bash prompt.
Install the latest version of Node:
nvm install node
Optional: Set a default browser
Optionally, set a default browser so
polymer serve --open has something to open. Use your own
echo $'\n'export BROWSER=/mnt/c/Program\\\ Files\\\ \\\(x86\\\)/ Google/Chrome/Application/chrome.exe >> ~/.bashrc