Skip to content

Installation

Jump to bottom
Dragon edited this page Dec 22, 2025 · 2 revisions 
# 📦 Installation Guide

This guide will help you install NaviDuck on any platform. NaviDuck is designed to be simple to install with minimal dependencies.

## 📋 Prerequisites

### System Requirements
- **Operating System**: Windows 7+, macOS 10.12+, Linux (any modern distribution)
- **Python**: Version 3.6 or higher
- **RAM**: Minimum 512MB (1GB recommended)
- **Disk Space**: 10MB free space

### Required Knowledge
- Basic command-line/terminal usage
- Basic Python installation knowledge

---

## 🔍 Verify Your Python Installation

Before installing NaviDuck, check if you have Python installed:

```bash
python --version
# or
python3 --version

You should see something like:

Python 3.8.5

If you don't have Python installed, install it first:

Windows

  1. Download from python.org
  2. Run the installer
  3. IMPORTANT: Check "Add Python to PATH"
  4. Complete installation

macOS

# Using Homebrew (recommended)
brew install python

# Or download from python.org

Linux

# Ubuntu/Debian
sudo apt update
sudo apt install python3 python3-pip

# Fedora
sudo dnf install python3 python3-pip

# Arch Linux
sudo pacman -S python python-pip

🚀 Quick Installation (All Platforms)

Method 1: One-Line Install (Recommended)

git clone https://github.com/DAPOWER99/NaviDuck.git && cd NaviDuck && pip install requests && echo "✅ NaviDuck installed! Run with: python naviduck.py"

Method 2: Step-by-Step

# 1. Clone the repository
git clone https://github.com/DAPOWER99/NaviDuck.git

# 2. Navigate to the directory
cd NaviDuck

# 3. Install dependencies
pip install -r requirements.txt

# 4. Run NaviDuck!
python naviduck.py

💻 Platform-Specific Instructions

🪟 Windows Installation

Option A: Using Git Bash (Recommended)

  1. Install Git for Windows
  2. Open Git Bash
  3. Run the quick install command above

Option B: Using PowerShell

# Clone the repository
git clone https://github.com/DAPOWER99/NaviDuck.git
cd NaviDuck

# Install dependencies
pip install requests

# Run NaviDuck
python naviduck.py

Option C: Using Command Prompt

git clone https://github.com/DAPOWER99/NaviDuck.git
cd NaviDuck
pip install requests
python naviduck.py

Optional: Windows Terminal Integration

For the best experience on Windows, install Windows Terminal and a Nerd Font like "CaskaydiaCove NF".

🍎 macOS Installation

Option A: Using Homebrew (Recommended)

# Install Homebrew if you don't have it
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install Git and Python
brew install git python

# Then install NaviDuck
git clone https://github.com/DAPOWER99/NaviDuck.git
cd NaviDuck
pip3 install requests
python3 naviduck.py

Option B: Using Python.org Installer

  1. Download Python from python.org
  2. Run the installer
  3. Open Terminal and follow the quick install steps

Optional: iTerm2 + Fonts

For better icon support:

# Install iTerm2
brew install --cask iterm2

# Install a Nerd Font
brew install --cask font-caskaydia-cove-nerd-font

🐧 Linux Installation

Ubuntu/Debian

# Update package list
sudo apt update

# Install Git and Python
sudo apt install git python3 python3-pip

# Install NaviDuck
git clone https://github.com/DAPOWER99/NaviDuck.git
cd NaviDuck
pip3 install requests
python3 naviduck.py

Fedora/RHEL/CentOS

# Install Git and Python
sudo dnf install git python3 python3-pip

# Install NaviDuck
git clone https://github.com/DAPOWER99/NaviDuck.git
cd NaviDuck
pip3 install requests
python3 naviduck.py

Arch Linux

# Install Git and Python
sudo pacman -S git python python-pip

# Install NaviDuck
git clone https://github.com/DAPOWER99/NaviDuck.git
cd NaviDuck
pip install requests
python naviduck.py

📦 Alternative Installation Methods

Docker Installation (Advanced)

# Create a Dockerfile
cat > Dockerfile << 'EOF'
FROM python:3.9-slim
WORKDIR /app
COPY . .
RUN pip install requests
CMD ["python", "naviduck.py"]
EOF

# Build and run
docker build -t naviduck .
docker run -it naviduck

Virtual Environment Installation (Recommended for Developers)

# Create virtual environment
python -m venv naviduck_env

# Activate it
# On Windows:
naviduck_env\Scripts\activate
# On Unix/Mac:
source naviduck_env/bin/activate

# Install in virtual environment
git clone https://github.com/DAPOWER99/NaviDuck.git
cd NaviDuck
pip install requests
python naviduck.py

# Deactivate when done
deactivate

System-Wide Installation

# Install globally (requires admin/root)
sudo pip install git+https://github.com/DAPOWER99/NaviDuck.git

# Then run from anywhere
python -m naviduck

🔧 Optional Dependencies

For the best experience, consider installing these optional packages:

Platform-Specific Enhancements

# Windows - Better Ctrl+X handling
pip install pywin32

# Linux/Mac - Better terminal experience
pip install gnureadline

# All platforms - Better colors
pip install colorama

# All platforms - Advanced CLI features
pip install prompt-toolkit

All Optional Packages at Once

pip install -r requirements-full.txt

(Create a requirements-full.txt with all optional packages)

✅ Verification & Testing

After installation, verify everything works:

# Test 1: Check Python version
python --version

# Test 2: Check requests installation
python -c "import requests; print('✅ requests installed successfully')"

# Test 3: Run NaviDuck test
cd NaviDuck
python -c "import sys; sys.path.insert(0, '.'); from naviduck import main; print('✅ NaviDuck imports successfully')"

# Test 4: Quick functional test
echo "Testing basic search..." && python -c "
import sys
sys.path.insert(0, '.')
from naviduck import Colors
print(f'{Colors.GREEN}✅ Basic test passed{Colors.RESET}')
"

🐛 Troubleshooting

Common Issues

Issue: "pip is not recognized"

Solution:

# On Windows, try:
py -m pip install requests

# On Linux/Mac, try:
python3 -m pip install requests

Issue: "git is not recognized"

Solution: Install Git first:

Issue: "ModuleNotFoundError: No module named 'requests'"

Solution:

# Ensure you're in the NaviDuck directory
cd NaviDuck

# Install requests
pip install requests --user

# Or use system pip
sudo pip install requests

Issue: Python 2.x instead of 3.x

Solution: Use python3 instead of python:

python3 --version
python3 naviduck.py
pip3 install requests

Issue: Permission errors on Linux/Mac

Solution: Use --user flag or sudo:

# Option 1: Install for current user
pip install requests --user

# Option 2: Use sudo (not recommended for security)
sudo pip install requests

Windows-Specific Issues

Issue: Python not in PATH

Solution: Reinstall Python and check "Add Python to PATH"

Issue: Antivirus blocking

Solution: Add exception for Python and NaviDuck directory

macOS-Specific Issues

Issue: "xcrun: error: invalid active developer path"

Solution:

xcode-select --install

Issue: SIP restrictions

Solution: Install with --user flag

Linux-Specific Issues

Issue: Old Python version

Solution:

# Ubuntu/Debian
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt update
sudo apt install python3.9

# Or use pyenv
curl https://pyenv.run | bash
pyenv install 3.9.0
pyenv global 3.9.0

🔄 Updating NaviDuck

To update to the latest version:

# Navigate to your NaviDuck directory
cd NaviDuck

# Pull the latest changes
git pull origin main

# Update dependencies
pip install --upgrade requests

🗑️ Uninstallation

Remove from System

# Navigate to NaviDuck directory
cd NaviDuck

# Remove the directory
cd ..
rm -rf NaviDuck  # On Windows: rmdir /s NaviDuck

# Optional: Remove requests if not used elsewhere
pip uninstall requests

Remove Virtual Environment

# Simply delete the environment folder
rm -rf naviduck_env  # On Windows: rmdir /s naviduck_env

📊 Installation Methods Comparison

Method Difficulty Best For Notes
Quick Install ⭐☆☆☆☆ Beginners Fastest, all platforms
Git + pip ⭐⭐☆☆☆ Most users Standard method
Virtual Env ⭐⭐⭐☆☆ Developers Isolated environment
Docker ⭐⭐⭐⭐☆ Advanced users Containerized
System Install ⭐⭐⭐⭐⭐ System admins Global installation

🎯 Recommended Setup by User Type

👤 Casual User 

git clone https://github.com/DAPOWER99/NaviDuck.git
cd NaviDuck
pip install requests
python naviduck.py

👨‍💻 Developer 

# Use virtual environment
python -m venv naviduck_env
source naviduck_env/bin/activate  # Windows: naviduck_env\Scripts\activate
git clone https://github.com/DAPOWER99/NaviDuck.git
cd NaviDuck
pip install -r requirements-full.txt
python naviduck.py

🛠️ System Administrator 

# Install globally
sudo pip install git+https://github.com/DAPOWER99/NaviDuck.git

# Create alias for easy access
echo "alias naviduck='python -m naviduck'" >> ~/.bashrc
source ~/.bashrc

# Run from anywhere
naviduck

🐳 Docker User 

# Pull and run
docker run -it dapower99/naviduck:latest

❓ Still Having Issues?

  1. Check the FAQ
  2. Search GitHub Issues
  3. Ask in Discussions
  4. Ensure you meet all prerequisites

✅ Installation Checklist

  • Python 3.8+ installed
  • Git installed (for cloning)
  • requests library installed
  • NaviDuck repository cloned
  • Successfully ran python naviduck.py
  • Can run ai hello command
  • Can run s test command

🎉 Congratulations!

You've successfully installed NaviDuck! Now check out:

Happy browsing! 🦆💻

Last updated: 12/22/2025
Installation guide version: 2.0


This comprehensive installation guide covers:
1. All major platforms (Windows, macOS, Linux)
2. Multiple installation methods
3. Troubleshooting for common issues
4. Verification steps
5. User-specific recommendations
6. Clear step-by-step instructions

It's designed to help users of all skill levels get NaviDuck running quickly and efficiently!

Clone this wiki locally