Skip to main content

Installation Guide

Prerequisites​

Before installing, make sure your computer has:

Node.js Environment​

  • Node.js 20 or newer
    • You can run node --version in the terminal to check the current version
    • If you don't have it or the version is too old, please download the latest LTS version from nodejs.org

What is LTS? LTS stands for Long Term Support, which is the stable version of Node.js recommended for daily use.

Special Notes for Windows Users​

📝 Important Recommendation: Windows users strongly recommend using Git Bash as the command-line terminal. We have thoroughly validated it in Git Bash, while CMD/PowerShell only has simple compatibility support.

Why recommend Git Bash?

  • Provides a Unix-like environment with consistent experience with macOS/Linux
  • We have conducted complete functional testing and validation in this environment
  • Supports full shell script functionality and environment variables
  • Better Chinese support and encoding handling

How to get Git Bash?

  1. Visit git-scm.com
  2. Download and install Git for Windows
  3. After installation, right-click on any folder and select "Git Bash Here"
  4. Or search for "Git Bash" in the Start Menu

Verify Git Bash Environment:

# Run in Git Bash, should see similar output
echo $SHELL
# Output: /usr/bin/bash or similar path

which node
# Output: /c/Program Files/nodejs/node or similar path

Installation Methods​

We provide two installation methods. You can choose one:

Run the following command in your terminal:

npm install --global @lovrabet/cli

What is --global? Global installation means you can use the lovrabet command from any directory, not just in the current project.

Method 2: Using Bun​

If you use Bun (a faster JavaScript runtime):

bun install --global @lovrabet/cli

Verify Installation​

After installation is complete, run the following command in the terminal to verify whether the installation was successful:

lovrabet --help

If you see output similar to the following, the installation was successful:

Lovrabet CLI - Frontend Development Scaffold

Usage:
  lovrabet <command> [options]

Available commands:
  create    Create new project
  auth      Login authentication
  ...

Upgrade to Latest Version​

When a new version is released, you can re-run the installation command to upgrade:

npm install --global @lovrabet/cli

Or if you're using Bun:

bun install --global @lovrabet/cli

Tip: Regular upgrades let you experience the latest features and bug fixes.

Installation Troubleshooting​

Issue 1: Node.js Version Too Low​

Error Message: Node.js version 18.x.x is not supported

Solution:

  1. Visit nodejs.org
  2. Download the latest LTS version (version 20.x or higher)
  3. Re-run the installation command after installation

Windows Users Note:

  • After installing Node.js, reopen your Git Bash window
  • Verify in Git Bash: node --version

Issue 2: Cannot Download Package​

Error Message: 404 Not Found - GET https://registry.npmjs.org/@lovrabet%2fcli

Solution:

  1. Check if network connection is working
  2. Check npm source configuration to ensure access to private npm registry
  3. Contact administrator for correct .npmrc configuration

Issue 3: No Global Installation Permission​

Error Message: permission denied

Solution:

  • macOS/Linux: Add sudo before the command 
    sudo npm install --global @lovrabet/cli
  • Windows: Run Git Bash as administrator
    • Right-click on Git Bash icon
    • Select "Run as administrator"
    • Try installation command again

Issue 4: Windows Terminal Environment Selection​

Symptom: Different experiences in different Windows terminals

Recommended Solutions:

  1. Best Choice - Git Bash: Fully tested and verified, best experience

    # Execute in Git Bash, fully functional
    lovrabet --help

  2. Alternative - CMD/PowerShell: Basic functions available, but not fully tested

    REM May need additional settings in CMD
    lovrabet --help
    # May encounter some limitations in PowerShell
    lovrabet --help

  3. Recommendations when encountering problems:

    • First try the same operation in Git Bash
    • If it works in Git Bash, it indicates a terminal environment issue
    • You can continue using other terminals, but may need to manually handle some issues

Still Can't Resolve It?​

Please see the Troubleshooting documentation, or contact technical support.

When contacting support, please provide:

  • Operating system version
  • Node.js version
  • Terminal type used (specifically note whether it's Git Bash)
  • Complete error message