Installation Guide
Step-by-step installation guide for VibeCodingTutor on Linux, macOS, Windows, and FreeBSD
🚀 Quick Installation
Get VibeCodingTutor running in under 2 minutes!
Prerequisites
Before installing, ensure you have:
- ✅ Python 3.8 or higher (Download Python)
- ✅ A terminal emulator (built into all OS)
- ✅ Git (optional, for cloning)
Verify Python Installation
python3 --version
# Should show: Python 3.8+
🐧 Linux Installation
Method 1: Quick Install Script
# Clone the repository
git clone https://codeberg.org/toulcit/vibecodingtutor.git
cd vibecodingtutor
# Run the installer
./install.sh
# Launch!
vibecodingtutor
Method 2: Manual Installation
# Clone
git clone https://codeberg.org/toulcit/vibecodingtutor.git
cd vibecodingtutor
# Run directly
python3 vibetutor.py
Method 3: pip Installation (Coming Soon)
pip install vibecodingtutor
vibecodingtutor
Linux-Specific Notes
- Ubuntu/Debian: Python usually pre-installed
- Arch Linux:
sudo pacman -S python - Fedora:
sudo dnf install python3 - curses: Built-in, no extra dependencies needed
🍎 macOS Installation
Method 1: Quick Install Script
# Clone the repository
git clone https://codeberg.org/toulcit/vibecodingtutor.git
cd vibecodingtutor
# Run the installer
./install.sh
# Launch!
vibecodingtutor
Method 2: Manual Installation
# Clone
git clone https://codeberg.org/toulcit/vibecodingtutor.git
cd vibecodingtutor
# Run directly (macOS may need python3 from Homebrew)
python3 vibetutor.py
Installing Python on macOS
If Python isn’t installed:
# Using Homebrew (recommended)
brew install python
# Or download from python.org
# https://www.python.org/downloads/macos/
macOS-Specific Notes
- Terminal.app: Works perfectly
- iTerm2: Works perfectly with colors
- Warp: Fully supported
- curses: Built-in on macOS
🪟 Windows Installation
Method 1: Using Git Bash or WSL (Recommended)
# Clone the repository
git clone https://codeberg.org/toulcit/vibecodingtutor.git
cd vibecodingtutor
# Run the installer
./install.sh
# Launch!
vibecodingtutor
Method 2: Windows Command Prompt/PowerShell
# Clone the repository
git clone https://codeberg.org/toulcit/vibecodingtutor.git
cd vibecodingtutor
# Install windows-curses (required!)
pip install windows-curses
# Run the tutor
python vibetutor.py
Installing Python on Windows
- Download from python.org
- IMPORTANT: Check “Add Python to PATH” during installation
- Verify installation:
python --version
Windows-Specific Notes
- ⚠️ windows-curses is required:
pip install windows-curses - ✅ Windows Terminal: Recommended for best experience
- ✅ Git Bash: Works great with Unix-style commands
- ✅ WSL (Windows Subsystem for Linux): Full support, runs like Linux
- ⚠️ CMD/PowerShell: Works, but may have color limitations
Troubleshooting Windows
Error: “No module named ‘curses’”
pip install windows-curses
Colors not showing?
Use Windows Terminal instead of CMD:
- Download from Microsoft Store
- Free and modern terminal for Windows
🐉 FreeBSD Installation
# Install Python
sudo pkg install python39
# Clone the repository
git clone https://codeberg.org/toulcit/vibecodingtutor.git
cd vibecodingtutor
# Run the installer
./install.sh
# Launch!
vibecodingtutor
FreeBSD-Specific Notes
- curses: Built-in with Python
- Terminal: Works with xterm, alacritty, etc.
- Shell: bash, zsh, fish all work fine
🎨 Optional: PNG Certificate Generation
To generate professional PNG certificates:
# Install Pillow
pip install Pillow
# Or on systems with pip3
pip3 install Pillow
Note: This is optional. ASCII certificates work without it!
✅ Verify Installation
After installing, verify everything works:
# Run the tutor
vibecodingtutor
# Or
python3 vibetutor.py
You should see the VibeCodingTutor menu screen with 12 lessons!
🆘 Troubleshooting
“Permission denied” on install.sh
chmod +x install.sh
./install.sh
Python version too old
# Check your version
python3 --version
# If < 3.8, install newer Python
# Ubuntu/Debian
sudo apt update
sudo apt install python3.10
# macOS
brew install python
Terminal too small
Resize your terminal to at least 80x24 characters for the best experience.
Colors look wrong
Try these terminals for best color support:
- Linux: GNOME Terminal, Konsole, Alacritty
- macOS: iTerm2, Terminal.app, Warp
- Windows: Windows Terminal
- FreeBSD: Alacritty, xterm
Progress not saving?
Check the progress file location:
# Linux/macOS
cat ~/.local/share/vibecodingtutor/progress.json
# Windows
type %APPDATA%\vibecodingtutor\progress.json
📦 Uninstallation
If installed via install.sh
# Remove the symlink
rm ~/.local/bin/vibecodingtutor
# Remove progress and certificates
rm -rf ~/.local/share/vibecodingtutor
# Remove the repository
rm -rf /path/to/vibecodingtutor
If installed via pip (Coming Soon)
pip uninstall vibecodingtutor
🎯 What’s Next?
Once installed:
- Start with Lesson 1 - “What is Vibe Coding?”
- Complete all 12 lessons - Take your time!
- Earn your certificate - Share it on LinkedIn!
- Start vibe coding - Apply what you learned