Skip to main content

Installation Guide

Prerequisites​

Before installation, make sure your computer has the following installed:

Node.js Environment​

  • Node.js 20 or newer
    • Run node --version in terminal to check current version
    • If not installed or version is too old, 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 are strongly recommended to use Git Bash as their command-line terminal. We have thoroughly tested in Git Bash, while CMD/PowerShell only has basic compatibility support.

Why Git Bash is recommended?

  • Provides a Unix-like environment, consistent with macOS/Linux experience
  • We have conducted complete functional testing and verification in this environment
  • Supports full shell scripting and environment variables
  • Better Chinese character 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 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 either one:

Run the following command in terminal:

npm install --global @lovrabet/cli

What is --global? Global installation means you can use the lovrabet command in 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, run the following command in terminal to verify successful installation:

lovrabet --help

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

Lovrabet CLI - Frontend Development Scaffolding

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 run the installation command again 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. Run the installation command again after installation completes

Windows users note:

  • After installing Node.js, reopen the 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, 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 the Git Bash icon
    • Select "Run as administrator"
    • Try the installation command again

Issue 4: Windows terminal environment selection​

Symptom: Different experiences may occur in different Windows terminals

Recommended solutions:

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

    # Execute in Git Bash, full functionality
    lovrabet --help

  2. Alternative - CMD/PowerShell: Basic functionality available, but not thoroughly tested

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

  3. Suggestions when encountering issues:

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

Still can't solve it?​

Please check the Troubleshooting documentation, or contact technical support.

When contacting support, please provide:

  • Operating system version
  • Node.js version
  • Terminal type used (specifically note if using Git Bash)
  • Complete error message