How to use the CLI
The CLI has a some commands you can execute. To see all commands open up the terminal and type in:
With that you can find help instructions how to use @veams/cli.
But we always want to provide a better explanation. Here we go:
VEAMS contains some major commands. These are:
|generate||-g||Add a component or custom blueprint to your project (@see Command: generate)|
|help||-h||Show the help.|
|install||-i||Install extensions (@see Command: install).|
|new||-n||Create something new (@see Command: new)|
|update||-u||Update veams-cli and all packages|
|version||-v||Show VEAMS version|
For one command you can provide arguments (
veams command [arguments]).
new command creates a complete new setup for a project.
With that you can start to create a project from scratch.
The CLI guides you through a few questions and scaffolds a projects based on your given answers.
|project||p||Create a new project from scratch.||
generate command generates a
blueprint into your current project.
This could be a component, container or store for a React App, a new Mock API endpoint or a
It is up to you how the
blueprint can look like. You want to know more?
|component [name]||c||Add a component to your project||
|utility [name]||u||Add an utility to your project||
|bp [name]||You can also add custom blueprints||
install command you can integrate already existing
blueprints into you project.
|blueprint [path] [type]||bp||Install a blueprint based on
|component [name]||c||Install a specific veams-component.||
|package [sugar name]||p||Install a custom external package from
|utility [name]||u||Install a specific veams-utility.||