balm-cli

4.5.0 • Public • Published

Balm CLI NPM version

A simple CLI for scaffolding BalmJS projects.

Requirements

  1. Node.js >= 14.18.0
  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
  • 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
  • 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

Package Sidebar

Install

npm i balm-cli

Weekly Downloads

66

Version

4.5.0

License

MIT

Unpacked Size

37.5 kB

Total Files

30

Last publish

Collaborators

  • elf-mouse