Balm CLI

A simple CLI for scaffolding BalmJS projects.

Requirements

⚠️ NOTE: balm-cli >= 4.4.0 requires Node >= 18, balm-cli = 4.3.0 requires Node >= 16, balm-cli <= 4.2.0 requires Node >= 14.17.0

1. Node.js
2. Git
3. BalmJS balm-core >= 3

First install the balm-core globally.

npm install -g balm-core
# OR
yarn global add balm-core

Installation

Then install the balm-cli globally.

npm install -g balm-cli
# OR
yarn global add balm-cli

# Verify
balm -V
# Output:
# balm-cli: 4.0.0
# balm-core: 4.0.0 (Global)

⚠️ NOTE: For Windows users, use balm-cli@legacy

Usage

# See all available official templates
balm list

balm init <template-name> <project-name>

Example:

# Official template
balm init vue-ui my-project

# Custom template
balm init username/repo my-project

Official Templates

• Default
  • simple - A simple project
• Vue.js
  • vue - A Vue.js project
  • vue-expert - A Vue.js project with router
  • vue-master - A Vue.js project with router & store
  • vue-ui - A Vue.js project with router & BalmUI
  • vite - A Vue.js project with Vite & BalmUI (Recommended)
  • vue-ssr - A server-rendered Vue.js project (Experimental)
  • vue-ssr-without-vuex - A server-rendered Vue.js project without Vuex (Experimental)
  • vue-wechat-mp - 使用 Vue 同构微信小程序和 Web
• React
  • react - A React project
  • react-expert - A React project with router
  • react-master - A React project with router & store
• Angular
  • ng - An Angular project
• Desktop apps
  • electron - An Electron project
  • tauri - A Tauri project (Coming soon)
• Others
  • pwa - Progressive Web Apps project
  • legacy - A jQuery project for older browsers
  • svelte - A Svelte project
  • solid - A Solid project