Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

  ███╗   ███╗███████╗ ██████╗██╗  ██╗██████╗ ██╗   ██╗██╗██╗     ██████╗
  ████╗ ████║██╔════╝██╔════╝██║  ██║██╔══██╗██║   ██║██║██║     ██╔══██╗
  ██╔████╔██║█████╗  ██║     ███████║██████╔╝██║   ██║██║██║     ██║  ██║
  ██║╚██╔╝██║██╔══╝  ██║     ██╔══██║██╔══██╗██║   ██║██║██║     ██║  ██║
  ██║ ╚═╝ ██║███████╗╚██████╗██║  ██║██████╔╝╚██████╔╝██║███████╗██████╔╝
  ╚═╝     ╚═╝╚══════╝ ╚═════╝╚═╝  ╚═╝╚═════╝  ╚═════╝ ╚═╝╚══════╝╚═════╝

SP//DR Build System

Mech-assembly project scaffolding

npm version License: MIT Node TypeScript

Assemble your next project like deploying a mech.


✦ What is mechbuild?

mechbuild is a futuristic, interactive CLI scaffolding tool that generates production-ready project boilerplates.

Every developer choice is framed as selecting a mech component:

  • your framework is the chassis
  • your database is the memory core
  • auth is the security module

Built with a cyberpunk aesthetic that doesn't sacrifice practicality.


⚡ Features

  • 🤖 Futuristic terminal UX — styled prompts, gradients, ASCII art
  • 🏗️ Multi-framework support — Next.js, Express, FastAPI, React, Vue, SvelteKit, Go Fiber
  • 🗄️ Database integrations — PostgreSQL, MySQL, SQLite, MongoDB, Redis
  • 🔐 Auth scaffolding — JWT, OAuth (GitHub/Google), Session/Cookie
  • 📦 Extras system — Docker Compose, GitHub Actions CI, ESLint + Prettier, Husky, Conventional Commits
  • 💾 Preset system — save and reload build configurations via ~/.mechrc
  • 🧪 Dry-run mode — preview generated output without writing any files
  • 🎨 Beautiful output — boxen, gradient-string, chalk-powered success screens

📸 Screenshots

Terminal screenshots — coming soon

  ███████╗██████╗     ██╗   ██╗██████╗ ██████╗
  ...

  ◆ Designate your mech frame (project name)  › my-saas-app
  ◆ Select frame class (project type)         › Full Stack
  ◆ Install chassis (framework)               › Next.js App Router
  ◆ Bind memory core (database)               › PostgreSQL
  ◆ Arm security module (authentication)      › JWT
  ◆ Mount subsystems (extras)                 › Docker, GitHub Actions, ESLint

  ╔══════════════════════════════╗
  ║      BUILD MANIFEST          ║
  ║  PILOT ID    MY-SAAS-APP     ║
  ║  CHASSIS     nextjs          ║
  ║  MEMORY      postgresql      ║
  ╚══════════════════════════════╝

  Deploy this build? › Yes

  ✔ Initializing frame structure
  ✔ Writing 14 components
  ✔ Calibrating configuration
  ✔ Sealing chassis

  ╭────────────────────────────────────────────╮
  │  BUILD COMPLETE                            │
  │  ⚡ SP//DR online — my-saas-app assembled  │
  │                                            │
  │  📁 Location: ./my-saas-app                │
  │  🔧 Next Steps:                            │
  │    $ cd my-saas-app                        │
  │    $ npm install                           │
  │    $ npm run dev                           │
  ╰────────────────────────────────────────────╯

🛠 Installation

Global install (recommended)

npm install -g mechbuild

npx (no install)

npx mechbuild

From source

git clone https://github.com/YOUR_USERNAME/mechbuild-cli.git
cd mechbuild-cli
npm install
npm run build
npm link

🚀 Usage

Interactive wizard

mechbuild
# or explicitly:
mechbuild build

Dry run (preview only)

mechbuild --dry-run

Load a preset

mechbuild --preset saas-stack

Save current build as a preset

mechbuild --save-preset saas-stack

List saved presets

mechbuild presets

Delete a preset

mechbuild delete-preset saas-stack

🏁 CLI Flags

Flag Description
--dry-run Preview generation without writing files
--preset <name> Load a saved preset from ~/.mechrc
--save-preset <name> Save this config as a named preset
-v, --version Show version number
-h, --help Show help

📋 Supported Configurations

Project Types

Type Description
Web App Frontend SPA/SSR applications
API Server Backend REST/async APIs
Full Stack Integrated frontend + backend
CLI Tool Command-line interface programs

Frameworks

Category Options
Web App React (Vite), Next.js App Router, Vue (Vite), Svelte
API Express, FastAPI, Django REST, Go Fiber
Full Stack Next.js App Router, Nuxt, SvelteKit
CLI Tool Node CLI Starter, TypeScript CLI Starter

Databases

PostgreSQL · MySQL · SQLite · MongoDB · Redis · None


Authentication

JWT · OAuth GitHub · OAuth Google · Session + Cookie · None


Extras

Docker Compose · GitHub Actions CI · ESLint + Prettier · Husky Hooks · Conventional Commits · README Template


💾 Preset System

Presets are stored in ~/.mechrc as JSON:

{
  "saas-stack": {
    "projectName": "my-saas-app",
    "projectType": "fullstack",
    "framework": "nextjs",
    "database": "postgresql",
    "auth": "jwt",
    "extras": ["docker", "github-actions", "eslint"]
  }
}

🗺 Roadmap

  • Vue (Vite) full template set
  • SvelteKit full template set
  • Go Fiber full template set
  • Database migration scaffolding
  • Deployment config (Vercel, Railway, Fly.io)
  • Plugin system for custom templates
  • Interactive template preview
  • Config file support (.mechbuildrc)
  • Web UI companion app

🤝 Contributing

Contributions are welcome and appreciated!

  1. Fork the repository
  2. Create a feature branch
git checkout -b feat/my-feature
  1. Commit using conventional commits
feat: add X
fix: resolve Y
  1. Push and open a Pull Request

Please read CONTRIBUTING.md before submitting.


📄 License

MIT © mechbuild contributors


SP//DR Build System · Assemble the future.

About

SP//DR CLI is an interactive TypeScript-based project scaffolding tool that generates production-ready boilerplates for modern frameworks like Next.js, Express, FastAPI, and React using a stylish terminal wizard experience. It streamlines project setup with presets, automation tools, Docker, CI/CD configs, authentication systems.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages