Installation Guide

Get Macbrew up and running on your system in just a few minutes.

Prerequisites

Before installing Macbrew, make sure you have the following installed:

Quick Installation

The fastest way to try Macbrew is using npx:

npx macbrew

This will automatically download and run the latest version of Macbrew without installing anything permanently.

Global Installation

For regular use, install Macbrew globally:

npm install -g macbrew

Then run it:

macbrew

Platform-Specific Instructions

Windows

  1. Install Rust:

    # Download and run rustup-init.exe from https://rustup.rs/
# Or use winget
winget install Rust.Rust

  2. Install Python:

    # Download from https://www.python.org/downloads/
# Or use winget
winget install Python.Python.3.11

  3. Install Node.js:

    # Download from https://nodejs.org/
# Or use winget
winget install OpenJS.NodeJS

  4. Install Macbrew:

    npm install -g macbrew

macOS

  1. Install Rust:

    curl --proto "=https" --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

  2. Install Python (if not already installed):

    # Using Homebrew
brew install python@3.11

# Or download from https://www.python.org/downloads/

  3. Install Node.js:

    # Using Homebrew
brew install node

# Or download from https://nodejs.org/

  4. Install Macbrew:

    npm install -g macbrew

Linux

  1. Install Rust:

    curl --proto "=https" --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

  2. Install Python:

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

# CentOS/RHEL/Fedora
sudo dnf install python3 python3-pip
# or
sudo yum install python3 python3-pip

  3. Install Node.js:

    # Using NodeSource repository (Ubuntu/Debian)
curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt-get install -y nodejs

# CentOS/RHEL/Fedora
curl -fsSL https://rpm.nodesource.com/setup_18.x | sudo bash -
sudo yum install -y nodejs

  4. Install Macbrew:

    npm install -g macbrew

From Source

If you want to build from source or contribute to the project:

# Clone the repository
git clone https://github.com/Zemerik/Macbrew.git
cd Macbrew

# Install dependencies
npm install

# Build the project
npm run build

# Run in development mode
npm run dev

Verification

After installation, verify that Macbrew is working correctly:

# Check if Macbrew is installed
macbrew --version

# Start Macbrew
macbrew

# You should see the welcome message and prompt

First Run

When you run Macbrew for the first time, it will:

  1. Build the Rust binary (if not already built)
  2. Set up configuration in ~/.config/terminal-emulator/
  3. Install example plugins in ~/.config/terminal-emulator/plugins/
  4. Show the welcome message

Configuration

Macbrew creates a configuration file at:

You can customize various settings like:

Troubleshooting

Common Issues

“Rust is not installed”

# Install Rust
curl --proto "=https" --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

“Python is not found”

# Make sure Python 3.8+ is installed and in PATH
python3 --version
# or
python --version

“Permission denied”

# On Linux/macOS, you might need to use sudo
sudo npm install -g macbrew

# Or configure npm to use a different directory
npm config set prefix ~/.npm-global
export PATH=~/.npm-global/bin:$PATH

“Build failed”

# Clean and rebuild
npm run clean
npm run build

Getting Help

If you encounter any issues:

  1. Check the troubleshooting guide
  2. Search existing issues
  3. Create a new issue
  4. Join our Discussions

Next Steps

Now that you have Macbrew installed, check out: