@frizzyondabeat/volt-fast
v0.1.8
Published
a CLI tool for initial project setups and configurations including essential hooks and scripts
Readme
Table of Contents
Features
- Detects project context (Next.js, Vite, and TypeScript)
- Installs selected tooling dependencies for your package manager
- Generates ready-to-use config files for:
- Tailwind CSS
- Prettier
- ESLint
- Optionally initializes Shadcn UI with alias configuration
- Optionally copies custom hooks from the built-in templates
- Safe interactive flow with confirmations and cancellation handling
Requirements
- Node.js 18+ (Node.js 22 recommended)
- npm, pnpm, yarn, or bun
Quick Start
Run without global install:
pnpx @frizzyondabeat/volt-fast setupYou can also use:
npx @frizzyondabeat/volt-fast setupOr install globally:
npm i -g @frizzyondabeat/volt-fast
volt-fast setupCommand
volt-fast setup [projectdir]projectdiris optional- If omitted, the CLI prompts for the target directory
What It Generates
Depending on your selections, the CLI creates or updates:
.eslintrc.cjsprettier.config.cjspostcss.config.cjs- Tailwind CSS entry file (default:
./src/styles.css) tsconfig.jsonalias config for@/*(when Shadcn is enabled)tsconfig.app.jsonalias config for@/*in Vite projectsvite.config.tsorvite.config.jswithvite-tsconfig-pathsin Vite projects./hooks/*custom hooks (when enabled)
It also installs relevant dependencies in the target project and can run shadcn init.
Typical Flow
- Choose target project directory
- Confirm file overwrite warning
- Select tools (Tailwind, ESLint, Prettier, Shadcn UI)
- Optionally choose Tailwind CSS output path
- Optionally include custom hooks
- Confirm dependency install command
- CLI installs packages and writes files
- When selected, CLI configures aliases and runs Shadcn UI initialization
License
ISC
