vite-beam
v1.0.6
Published
One-command setup and deployment for Vite React apps to GitHub Pages
Maintainers
Readme
Vite Beam
💡 Instant Setup
⚡️ Lightning Fast Workflow
🛠️ Automated GitHub Actions
📦 Zero-Config Build & Deploy
🔩 Universal Vite Support
🔑 Fully Typed CLI Integration
Vite Beam (pronounced /viːt biːm/) is a lightweight developer experience (DevEx) CLI tool designed to automate the scaffolding, configuration, and continuous deployment of Vite-powered web applications directly to GitHub Pages.
It bridges the gap between your local terminal and GitHub cloud infrastructure in seconds:
- Automated Repository & CI/CD Pipeline: Scaffolds, configures, and commits standard GitHub Actions workflow files (
deploy.yml), project base paths, and workspace permissions automatically. - Instant Deployment Toolchain: Handles git initializations, dependency installations, and automated remote repository sync with a single command.
🚀 Quick Start
Run Vite Beam in your terminal to initialize and deploy your Vite project in one smooth step:
npx vite-beam <my-app-name>✨ Features
- ⚡ Zero-Touch GitHub Pages Deployment: Sets up full GitHub Actions runner workflows out of the box.
- 🔒 Automated Permissions: Configures
contents: writeandpages: writeworkflows automatically. - 🎯 Dynamic Base Pathing: Auto-detects repository names and sets
baseinvite.config.ts. - 📟 Clean Visual Output: Detailed step-by-step progress logging with ANSI ASCII completion banners.
🛠️ Requirements
- Node.js
18.xor higher - Git installed on your system
