vaadin/cli

A Command Line Interface (CLI) for creating new Vaadin projects.

A command line tool for creating new Vaadin applications.

Installation

npm i -g @vaadin/cli

Once installed, create a project using

vaadin init my-project

To create a design system documentation project (Vaadin Prime subscription required):

vaadin dsp-init

cli's Issues

Show an error message if a command or configuration property is not recognized

Currently if you run this:

vaadin blah

... it doesn't show anything, and just completes as if something had happened successfully. An error message should be shown instead:

> vaadin blah
Error: command 'blah' not recognized.

The same goes for unrecognized configuration properties, for example:

> vaadin init --drink beer my-project
Creating application 'my-project'
Project 'my-project' created

Instead of creating a project where that property may or may not have some impact, the command should fail saying that the property --drink is not recognized:

> vaadin init --drink beer my-project
Error: property '--drink' not recognized for the command 'init'.

Feature request: support for adding a database to a created project

It would be excellent if I could use Vaadin CLI to also enhance an existing project, for example, to add & configure a database. The result could be the same as if you had downloaded an app with the backend from start.

Add the User-Agent header to requests, so it can be tracked on the server-side

Currently we don't know how many people are using the CLI to initialize their projects.

To avoid problems with user consent, we should do the tracking on the server-side (Vaadin Start). What is needed in the CLI is to send a header so the server can identify the request as coming from CLI, and do the proper tracking.

Suggested implementation using the User-Agent header:

User-Agent: vaadin-cli/<version>