Creates a new Frontity project.

npx frontity create [project-name] [options]



The name of your Frontity project. It will also be the name of the folder that this command will create for you with the files of your Frontity project inside.




The theme to use


Adds support for TypeScript. Related environment variable: FRONTITY_CREATE_TYPESCRIPT


Generates the project in the current directory


frontity create initializes by default a git repository. This option skips this initialization.


Skips prompting the user for options. Related environment variable: FRONTITY_CREATE_NAME


Output usage information

The --theme option

You can either pick one of the two official Frontity themes (--theme @frontity/mars-theme or --theme @frontity/twentytwenty-theme) or use any other custom theme as long as it's published on npm. Just pass the theme name on the command-line like --theme ThemesPackageNameInNPM.


  • Create a Frontity project named my-awesome-project:

npx frontity create my-awesome-project
npx frontity create --theme frontity-chakra-theme cool-project
  • If you leave out both of the arguments, the CLI will run an interactive shell asking for these inputs:

> npx frontity create
? Enter a name for the project: awesome project
? Pick a starter theme to clone: @frontity/mars-theme (recommended)
✔ Creating
✔ Creating package.json.
✔ Creating frontity.settings.js.
✔ Cloning @frontity/mars-theme.
✔ Installing dependencies.
✔ Downloading favicon.ico.

Frontity project created.

? Do you want to receive framework updates by email? No

Ok, that's fine! 😉
You can subscribe at any point with npx frontity subscribe <email>.

Run cd awesome project && npx frontity dev and have fun! 🎉

You can find docs at
For technical support and assistance please join our community at

Environment Variables


If you pass the --no-prompt flag to the create command, the CLI will use the name from this FRONTITY_CREATE_NAME environment variable.

If the CLI cannot find a FRONTITY_CREATE_NAME environmental variable, it will prompt for the name of the package.



You can see a scheme of the whole workflow of using this FRONTITY_CREATE_NAME environment variable in the --no-prompt section.


Adds support for TypeScript in the project created.



Last updated