vv-update CLI

The vv-update CLI is a project maintenance tool to help an existing application bring in new file updates, syntaxes, standards, types, etc. from a recent VueVentus update, into an existing VueVentus dependent application - sometime after a prior vueventus CLI installation.

Installing VueVentus

Generally, you'd use the vv-update CLI with an application already using VueVentus. However, in case you may be just testing things out or for some reason don't yet have VueVentus installed, you can do so with the command:

npm install @obewds/vueventus

Getting Started

Assuming you already installed VueVentus with a CLI tool or manually, you can start the vv-update CLI with the command:

npx vv-update

Choose Your Stack

Some files with the same name are different between different installation stacks. So first up, the vv-update CLI will ask you which stack you are using. The currently supported stacks are:

1. SPA Stack: Vue 3, Tailwind CSS, Headless UI, Vue Router, Vite & Typescript
2. SSG Stack: Vite-SSG, Vue 3, Tailwind CSS, Headless UI, Pinia, Markdown, Auto-Loading & Typescript
3. Nuxt 3 Stack: Nuxt 3, Vue 3, Tailwind CSS, Headless UI, Pinia, Nuxt Content, & Typescript

Selecting a File

Once you've selected a stack, the vv-update CLI will present you with a scrolling selection of files, allowing you to select a specific file to install into the location that file would normally be installed into during a vueventus CLI installation of that same file (according to your chosen stack).

FILES ARE OVERWRITTEN

Please note that the vv-update CLI doesn't care if you've worked hard on customizing a file originally generated by the vueventus CLI!

This means the vv-update CLI will overwrite a file if it already exists, so always be sure you have versioning or the ability to undo a vv-update CLI selection to always ensure you have a way back out of an overwrite!

SKIP TO TEST DRIVE

If you'd like to skip ahead to the VvButton Test Drive, you'll skip the next install guide(s)!

Current Version:

v0.61.7