Navigation

Installation

Get the Loaded Vibes CLI installed and your environment configured in under 5 minutes.

Prerequisites

Before installing Loaded Vibes, ensure your system meets these requirements:

CommandDescription
Node.js≥ 18.0 (LTS recommended)
npm≥ 9.0 or pnpm ≥ 8.0
Git≥ 2.30
VS Code≥ 1.85 (with GitHub Copilot extension)

Optional but recommended

Install the GitHub Copilot and GitHub Copilot Chat extensions for full AI-assisted development. The framework works without them, but you'll miss out on the good vibes.

Installation Methods

npm (recommended)

Global installationbash
npm install -g @loaded-vibes/cli

pnpm

pnpm installationbash
pnpm add -g @loaded-vibes/cli

npx (no install)

Run without installingbash
npx @loaded-vibes/cli init my-project

Verify Installation

Confirm the CLI is installed correctly:

lv --version
# Output: @loaded-vibes/cli v1.0.0

lv doctor
# Checks environment, MCP servers, and VS Code integration

Post-Install Setup

1. Configure MCP Servers

Loaded Vibes uses Model Context Protocol servers for AI integration. The CLI will auto-detect your configuration, but you can also set it up manually:

.vscode/mcp.jsonjson
{
  "servers": {
    "filesystem": { "command": "npx", "args": ["-y", "@anthropic/mcp-filesystem"] },
    "git": { "command": "npx", "args": ["-y", "@anthropic/mcp-git"] },
    "memory": { "command": "npx", "args": ["-y", "@anthropic/mcp-memory"] },
    "github": { "command": "npx", "args": ["-y", "@anthropic/mcp-github"] }
  }
}

2. Set Up GitHub Token

For GitHub MCP server integration:

# Create a GitHub Personal Access Token with repo scope
# Then set it in your environment:
export GITHUB_TOKEN=ghp_your_token_here

# Or add to your shell profile (~/.zshrc, ~/.bashrc)

3. Open in VS Code

After initializing a project, open it in VS Code to activate the workspace-specific settings and Copilot instructions:

code my-project
💡

Auto-configuration

The lv init command sets up VS Code settings, MCP configurations, and Copilot instructions automatically. You shouldn't need to configure anything manually unless you're customizing the framework.

Troubleshooting

Command not found

If lv isn't recognized after installation:

# Check npm global bin is in PATH
npm config get prefix

# Add to PATH (example for zsh)
export PATH="$(npm config get prefix)/bin:$PATH"

Permission errors

On macOS/Linux, if you get permission errors:

# Fix npm permissions (one-time setup)
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH

MCP Server connection issues

# Run diagnostics
lv doctor --verbose

# Reset MCP configuration
lv config --reset-mcp
⚠️

Windows users

Some MCP servers may require WSL2 for optimal performance. If you encounter issues, run the CLI inside WSL2 or use the Docker-based installation method.

Next Steps

Now that you have the CLI installed, head to the Quick Start guide to create your first project, or explore the Architecture documentation to understand how the framework is structured.