Skip to main content

Windows User Special Guide

This guide provides detailed instructions and precautions specifically for Windows users using Lovrabet CLI.

📝 Important Recommendations​

For the best experience, we strongly recommend Windows users use Git Bash. Support in different terminals:

  • ✅ Git Bash - Fully tested and verified, complete functionality, best experience
  • ⚠️ Windows CMD - Basic functions available, but not thoroughly tested
  • ⚠️ PowerShell - Basic functions available, may have some limitations
  • ⚠️ Windows Terminal - Depends on the specific shell type being used

Environment Preparation​

1. Install Git for Windows​

This is a necessary step for using Lovrabet CLI:

  1. Visit https://git-scm.com/download/win
  2. Download the latest version of Git for Windows
  3. Run the installer, use default settings
  4. After installation completes, you have Git Bash

2. Install Node.js​

  1. Visit https://nodejs.org/
  2. Download the latest LTS version (version >= 20)
  3. Run the installer
  4. Important: Restart your computer or reopen all terminal windows after installation

3. Verify Environment​

Open Git Bash and run the following commands:

# Check Git Bash environment
echo $0
# Should output something like "-bash" or containing "bash"

# Check Node.js
node --version
# Should output v20.x.x or higher

# Check npm
npm --version
# Should output version number

Install Lovrabet CLI​

Run in Git Bash:

npm install --global @lovrabet/cli

If you encounter permission issues, try running Git Bash as administrator:

  1. Right-click the Git Bash icon
  2. Select "Run as administrator"
  3. Re-run the install command

Complete Usage Example​

Here's a complete Windows usage workflow (using Git Bash as an example, recommended):

# 1. Open Git Bash (right-click folder and select Git Bash Here)

# 2. Verify environment
node --version
lovrabet --version

# 3. Login authentication
lovrabet auth
# Browser will automatically open, complete login then return to terminal and press q to exit

# 4. Create project
lovrabet create my-project
cd my-project

# 5. Configure application
lovrabet config set app my-app-code

# 6. Generate API
lovrabet api pull

# 7. Start development server
lovrabet start
# Browser will automatically open http://localhost:5173

Get Help​

If you encounter other issues:

  1. Check troubleshooting guide: Troubleshooting Guide
  2. Try different terminals: If you encounter issues in CMD/PowerShell, try repeating the operation in Git Bash
  3. Collect information: Provide detailed error messages and system information to technical support

When providing information, please include:

  • Windows version: Run winver to check
  • Git Bash version: Run git --version to check
  • Node.js version: Run node --version to check
  • CLI version: Run lovrabet --version to check
  • Complete error message screenshots