CLI
Nuxt Ignis comes with couple of CLI commands to help you move faster.
Quick-start
Nuxt Ignis provides a one-command-to-set-them-all way to set everything up in your project. It can be invoked as:
pnpx nuxt-ignis setupnpx nuxt-ignis setupyarn dlx nuxt-ignis setup$ bunx nuxt-ignis setup$ deno run --allow-run npm:npx nuxt-ignis setupFirst, the CLI tool will ask whether you want to do the setup automatically:
- If you choose
yes, all actions will be subsequently performed automatically. - If you choose
no, you will be guided through the setup step-by-step prompting every action.
If action associated with each step was already performed or the code snippet is already present in the target file, the tool will skip to next one. In case an error occurs, the script continues towards the next step. This allows you to fix the issue later and run the command again to finish everything.
All the setup steps are described in detail in the installation guide.
Code scaffolding
As a base layer, Nuxt Ignis includes a number of built-ins that are automatically brought into your project just by extending from it. Since this might not always be exactly what you need and want, you are free to overwrite everything by your own files. However, sometimes you might just need a little tweak to the defaults and not a complete rewrite. To save you from digging into the source code and copy-pasting things into new files manually, there is a collection of CLI commands to scaffold the default files into your project so you can start editing them with little to no effort.
Currently, following options are available:
set-app-vue
For adjusting the application main entrypoint and its behavior, you can scaffold the default app/app.vue file into your project using:
pnpx nuxt-ignis set-app-vuenpx nuxt-ignis set-app-vueyarn dlx nuxt-ignis set-app-vue$ bunx nuxt-ignis set-app-vue$ deno run --allow-run npm:npx nuxt-ignis set-app-vueThe file will be created as app/app.vue and will be equal to the Nuxt Ignis default.
set-css
For adjusting the default CSS styling, you can scaffold the default app/assets/css/ignis.css file into your project using:
pnpx nuxt-ignis set-cssnpx nuxt-ignis set-cssyarn dlx nuxt-ignis set-css$ bunx nuxt-ignis set-css$ deno run --allow-run npm:npx nuxt-ignis set-cssThe file will be created as app/assets/css/ignis.css and will be equal to the Nuxt Ignis default.
NOTE: If NUXT_IGNIS_COPRENUXT_PUBLIC_IGNIS_CORE_CSS is set to false, this file is NOT included in the project automatially. You either need to re-enable it or set it manually.
set-eslint
For adjusting the ESLint configuration, you can scaffold the default eslint.config.mjs file into your project using:
pnpx nuxt-ignis set-eslintnpx nuxt-ignis set-eslintyarn dlx nuxt-ignis set-eslint$ bunx nuxt-ignis set-eslint$ deno run --allow-run npm:npx nuxt-ignis set-eslintThe file will be created as eslint.config.mjs and will be equal to the Nuxt Ignis default.