The Frontity command-line tool (CLI) is the main entry point for getting up and running with a Frontity application. It provides functionality like running a development server or building your Frontity application for deployment.
The Frontity CLI (Frontity commands) is available via npm. You can run any Frontity command by doing
npx frontity <frontity-command>
npx frontity --help for full help.
frontity commands you have available are:
These commands allow you to either create a Frontity project or a Frontity package:
These commands allow you to run a Frontity project in development or production mode:
These commands allow you to generate the code that can be used to run or analyze a Frontity project:
The Frontity CLI allows parametrization via arguments or environment variables to customize their execution.
If some of these arguments or environment variables are detected the proper values will be set and applied in the execution of the command.
--no-prompt option that can be used along with environment variables to avoid any questions from the CLI.
If the CLI cannot find any of these environmental variables, it will prompt for the name of the package.
This is the scheme followed by the CLI to get the name of the package:
Create a Frontity project:
npx frontity create my-cool-project
Add a custom theme (package):
npx frontity create-package my-custom-theme
Launch a development server:
npx frontity dev
Generate a build of the project:
npx frontity build
Launch the project in production using the build generated before:
npx frontity serve