Installation

Complete guide to installing MODL on different operating systems and environments.

Getting Started with Installation

Installing the MODL client is the first step to using MODL servers. The client manages server installation, updates, and communication with your terminal.

Prerequisites

•Cognitive Architecture Terminal: Version 2.0 or higher
•Operating System: macOS, Linux, or Windows 10/11
•Docker: Required for running MODL servers (automatically installed with MODL client)
•Disk Space: At least 2GB of free disk space
•Memory: Minimum 4GB RAM (8GB recommended)

macOS Installation

There are several ways to install MODL on macOS. Choose the method that works best for you.

Using Homebrew (Recommended)

If you have Homebrew installed, this is the easiest way to install MODL:

# Install MODL using Homebrew
brew install cognitive-modl

# Verify installation
modl --version

Using the Installer Script

You can use our installer script which will automatically download and set up MODL:

# Download and run the installer script
curl -fsSL https://get.cognitive-architecture.com/modl | sh

# Verify installation
modl --version

Manual Installation

If you prefer to install manually, you can download the binary directly:

Download the latest release from our downloads page
Extract the archive to a directory in your PATH (e.g., /usr/local/bin)
Make the binary executable with chmod +x /path/to/modl
Verify the installation with modl --version

Linux Installation

MODL can be installed on most Linux distributions using package managers or our installer script.

Debian/Ubuntu (apt)

# Add our repository
curl -fsSL https://repo.cognitive-architecture.com/modl/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://repo.cognitive-architecture.com/modl stable main"

# Update and install
sudo apt-get update
sudo apt-get install cognitive-modl

# Verify installation
modl --version

Fedora/RHEL/CentOS (dnf/yum)

# Add our repository
sudo rpm --import https://repo.cognitive-architecture.com/modl/gpg
sudo dnf config-manager --add-repo https://repo.cognitive-architecture.com/modl/modl.repo

# Install MODL
sudo dnf install cognitive-modl

# Verify installation
modl --version

Using the Installer Script (All Distributions)

# Download and run the installer script
curl -fsSL https://get.cognitive-architecture.com/modl | sh

# Verify installation
modl --version

Windows Installation

MODL can be installed on Windows using several methods.

Using the Windows Installer

Download the latest Windows installer (.msi) from our downloads page
Run the installer and follow the on-screen instructions
Open a new Command Prompt or PowerShell window
Verify the installation with modl --version

Using PowerShell

# Run this command in PowerShell as Administrator
iwr -useb https://get.cognitive-architecture.com/modl-win.ps1 | iex

# Verify installation
modl --version

Using Chocolatey

# Install using Chocolatey
choco install cognitive-modl

# Verify installation
modl --version

Docker Installation

If you prefer to run MODL in a Docker container, you can use our official Docker image.

# Pull the latest MODL image
docker pull cognitive/modl:latest

# Run MODL in a container
docker run -it --rm cognitive/modl:latest

# You can also mount a volume to persist data
docker run -it --rm -v modl-data:/root/.modl cognitive/modl:latest

Note on Docker Installation

When running MODL in Docker, you'll need to use Docker-in-Docker to run MODL servers, as they are also containerized. Our Docker image is configured to support this, but you may need to provide additional permissions to the container.

Verifying Your Installation

After installing MODL, you should verify that it's working correctly.

Basic Verification

# Check MODL version
modl --version

# Output should be similar to:
# MODL Client v2.5.0

System Check

# Run the MODL doctor command to check your system
modl doctor

# This will verify:
# - Docker installation
# - Network connectivity
# - Permissions
# - Available disk space
# - Other system requirements

Test Server Installation

# Try installing a test server
modl install hello-world

# Run the hello-world server
modl run hello-world

# You should see a welcome message if everything is working correctly

Troubleshooting Installation Issues

If you encounter issues during installation, here are some common problems and solutions.

Command Not Found

If you get a "command not found" error when trying to run modl, the binary might not be in your PATH.

Solution: Add the installation directory to your PATH, or create a symbolic link to the binary in a directory that's already in your PATH.

Docker Not Available

MODL requires Docker to run servers. If Docker isn't installed or running, you'll see an error.

Solution: Install Docker from the official Docker website, or run modl setup docker to have MODL install Docker for you.

Permission Denied

You might see permission errors when trying to install or run MODL.

Solution: Make sure you have the necessary permissions. On Linux and macOS, you might need to use sudo for installation. For Docker-related permissions, make sure your user is in the docker group.

Next Steps

Now that you have MODL installed, you can start using it to enhance your AI terminal experience.

Basic Usage

Learn how to use MODL commands and interact with servers.

Read Guide

Server Management

Learn how to install, update, and configure MODL servers.

Read Guide