MacOS Deployment Tutorial

This document will guide you through deploying Nekro Agent on MacOS systems.

🌈 Environment Preparation

Since Nekro Agent runs based on Docker, we recommend using OrbStack as the container management tool on MacOS, and deploy through its virtual machine functionality.

Install OrbStack

Method 1: Install using Homebrew (Recommended)

brew install --cask orbstack

Method 2: Direct Download and Installation

1. Visit OrbStack Official Website to download the latest version
2. Start OrbStack application after installation is complete
3. Confirm OrbStack is running properly (OrbStack icon should be displayed in the status bar)

Create and Use OrbStack Virtual Machine

1. Open OrbStack application
2. Click "Create Machine" to create a new Linux virtual machine (Ubuntu is recommended)
3. Or use command line to create:

orb create ubuntu my-machine

Using Virtual Machine in OrbStack

OrbStack provides a simple way to enter virtual machines and execute commands:

• Directly type orb command to enter the terminal of the default virtual machine
• Use orb -m <virtual machine name> to enter a specified virtual machine
• Use orb <command> to execute commands in the default virtual machine
• Use orb -m <virtual machine name> <command> to execute commands in a specified virtual machine

For example:

# Enter the default virtual machine
orb

# Enter the virtual machine named ubuntu
orb -m ubuntu

# Execute ls command in the default virtual machine
orb ls

# Execute ls command in the ubuntu virtual machine
orb -m ubuntu ls

🚀 Deployment Methods (in OrbStack Virtual Machine)

After entering the OrbStack virtual machine, the deployment process is completely identical to that in a standard Linux environment.

Please refer to the Linux Deployment Tutorial to complete subsequent deployment and configuration.