NullVoider commited on
Commit
960e999
Β·
verified Β·
1 Parent(s): 4f26a6a

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +2376 -0
README.md ADDED
@@ -0,0 +1,2376 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: gpl-3.0
3
+ tags:
4
+ - Machine learning & AI
5
+ - Operating systems
6
+ ---
7
+
8
+ # macOS 15.7.5
9
+
10
+ **AI Agent Development, Evaluation & Deployment Environment**
11
+ **Version:** 1
12
+ **Base System:** macOS Sequoia 15.7.5
13
+ **Architecture:** x86_64
14
+ **Last Updated:** May 2026
15
+ **Developer:** Kartik (NullVoider)
16
+
17
+ ---
18
+
19
+ ## βš–οΈ Legal Notice
20
+
21
+ **IMPORTANT - PLEASE READ CAREFULLY**
22
+
23
+ This container includes macOS, which is proprietary software owned by Apple Inc. By using this container, you acknowledge and agree to the following:
24
+
25
+ 1. **Apple EULA Compliance**: You must comply with Apple's Software License Agreement for macOS. The developer of this container does not grant, and cannot grant, any rights to macOS itself.
26
+
27
+ 2. **Licensing Separation**:
28
+ - The container infrastructure (Docker configuration, scripts, documentation) is licensed under GPL-3.0
29
+ - macOS and Apple software remain under Apple's EULA
30
+ - You must comply with BOTH licenses
31
+
32
+ 3. **Commercial Use**: Commercial deployment of macOS may require additional licensing from Apple. You are responsible for ensuring compliance with Apple's terms.
33
+
34
+ 4. **No Warranty**: This container is provided "as is" without any warranty. The developer is not affiliated with or endorsed by Apple Inc.
35
+
36
+ 5. **User Responsibility**: You are solely responsible for ensuring your use of this container complies with all applicable licenses, laws, and regulations.
37
+
38
+ **By proceeding to use this container, you acknowledge that you have read, understood, and agree to comply with both the GPL-3.0 license (for container components) and Apple's EULA (for macOS).**
39
+
40
+ ---
41
+
42
+ ## Getting Started
43
+
44
+ ### Clone the Repository
45
+
46
+ The QCOW2 disk image is hosted on HuggingFace due to its size. The setup scripts handle downloading it alongside the repository files automatically. It is recommended to use the below command to clone the repository.
47
+
48
+ **Linux / macOS:**
49
+ ```bash
50
+ curl -fsSL https://raw.githubusercontent.com/nullvoider07/mac15-base/master/scripts/setup-mac15.sh | bash
51
+ ```
52
+
53
+ **Windows (PowerShell):**
54
+ ```powershell
55
+ irm https://raw.githubusercontent.com/nullvoider07/mac15-base/master/scripts/setup-mac15.ps1 | iex
56
+ ```
57
+
58
+ The scripts will clone the repository, download the QCOW2 image from HuggingFace, and place all files in the correct locations automatically. Once complete, proceed to [Installation & Deployment](#installation--deployment).
59
+
60
+ ---
61
+
62
+ ## Table of Contents
63
+
64
+ 1. [Overview](#overview)
65
+ 2. [Key Features](#key-features)
66
+ 3. [Container Capabilities](#container-capabilities)
67
+ - [Operating System](#operating-system)
68
+ - [Development Tools](#development-tools)
69
+ - [Remote Access](#remote-access)
70
+ 4. [Technical Specifications](#technical-specifications)
71
+ - [System Requirements](#system-requirements)
72
+ - [Container Resource Usage](#container-resource-usage)
73
+ - [Performance Metrics](#performance-metrics)
74
+ 5. [Installation & Deployment](#installation--deployment)
75
+ - [Prerequisites](#prerequisites)
76
+ - [Docker Compose Deployment](#docker-compose-deployment)
77
+ - [Testing the Container](#testing-the-container)
78
+ 6. [Customizing the Image](#customizing-the-image)
79
+ 7. [Installed Software](#installed-software)
80
+ 8. [Development Environments](#development-environments)
81
+ 9. [The-Eye Integration](#the-eye-integration)
82
+ 10. [Task Executor REST API](#task-executor-rest-api)
83
+ 11. [Remote Access Methods](#remote-access-methods)
84
+ - [NoMachine (Recommended)](#nomachine-recommended)
85
+ - [VNC (Temporary Monitoring)](#vnc-temporary-monitoring)
86
+ - [SSH Access](#ssh-access)
87
+ 12. [Troubleshooting](#troubleshooting)
88
+ 13. [CI/CD Integration](#cicd-integration)
89
+ 14. [Reporting Issues](#reporting-issues)
90
+ 15. [FAQ](#faq)
91
+ 16. [License](#license)
92
+ 17. [About This Project](#about-this-project)
93
+
94
+ ---
95
+
96
+ ## Overview
97
+
98
+ The **macOS 15.7.5 Container** is a complete macOS Sequoia environment designed for AI agent development, evaluation, testing, and deployment β€” including Computer Use Agents (CUA) and coding agents. It provides a full macOS desktop experience with pre-configured development tools, integrated monitoring capabilities, and a REST API task executor β€” all within a single Docker container.
99
+
100
+ **IMPORTANT LEGAL NOTICE**: This container includes macOS software. By using this container, you agree to comply with Apple's Software License Agreement (EULA) for macOS. The GPL-3.0 license applies to the container configuration, scripts, and custom components created by the developer, but does not and cannot apply to macOS itself or Apple's proprietary software. Users are responsible for ensuring their use complies with Apple's EULA.
101
+
102
+ ### Purpose
103
+
104
+ This container is designed for:
105
+
106
+ - **Computer Use Agent Development**: Pre-configured environment for building and testing CUA applications
107
+ - **Coding Agent Evaluation**: Full OS environment for running coding agent benchmarks including SWE-bench Lite
108
+ - **AI Agent Development**: Pre-configured environment for building, testing, and deploying any AI agent
109
+ - **Task Execution via REST API**: Structured task submission, execution, and result retrieval over HTTP (port 9090)
110
+ - **macOS Development**: Native macOS environment for developing Mac-specific applications
111
+ - **Automated Testing**: Consistent, reproducible macOS environment for CI/CD pipelines
112
+ - **Remote Development**: Full-featured macOS desktop accessible via NoMachine and VNC
113
+ - **Multi-Language Development**: Support for 10+ programming languages out of the box
114
+ - **Visual Monitoring**: Integrated Eye tool for screen capture and agent training data collection
115
+
116
+ ### What Makes This Unique
117
+
118
+ - **Single Container Design**: Complete macOS 15.7.5 system with no external file dependencies
119
+ - **Ephemeral State**: Everything is isolated inside the container, providing clean state management
120
+ - **4TB Virtual Disk**: Massive storage capacity for development projects
121
+ - **RAM**: Customizable memory allocation (minimum 4 GB for smooth operation)
122
+ - **Optimized Performance**: Significantly smoother than Dockur and Docker-OSX alternatives
123
+ - **Fully Customizable**: Configuration can be modified to improve performance based on hardware
124
+ - **Zero External Files**: Unlike Dockur and Docker-OSX, everything is self-contained
125
+ - **Developer-Ready**: Pre-installed IDEs, tools, and language runtimes
126
+
127
+ **Note**: The virtual storage does not mandate requirement of exactly 4TB of storage in the device running the container. The virtual disk is a growable disk, and 4TB is the cap on the virtual disk.
128
+
129
+ ---
130
+
131
+ ## Key Features
132
+
133
+ ### Operating System
134
+ βœ… **macOS Sequoia 15.7.5** - Latest macOS release
135
+ βœ… **Virtual Disk** - Massive 4TB virtual storage
136
+ βœ… **RAM** - Customizable memory allocation (minimum 4 GB for smooth operation)
137
+ βœ… **Intel i3 CPU Configuration** - Optimized for stability and compatibility
138
+ βœ… **Ephemeral State** - Clean isolation with no external dependencies
139
+
140
+ ### Development Tools
141
+ βœ… **10+ Languages** - Python, Go, Rust, Java, C#, C++, Node.js, TypeScript, Kotlin, Scala
142
+ βœ… **VS Code** - Pre-installed with essential extensions
143
+ βœ… **Xcode Tools** - Command line tools for macOS development
144
+ βœ… **Homebrew** - Package manager for macOS
145
+ βœ… **Git & Git LFS** - Version control with large file support
146
+ βœ… **Terminal Tools** - Modern shell utilities and productivity tools
147
+
148
+ ### Applications
149
+ βœ… **Brave Browser** - Privacy-focused web browser
150
+ βœ… **VS Code** - Feature-rich code editor
151
+ βœ… **Terminal Apps** - zsh, tmux, and modern CLI tools
152
+
153
+ ### Remote Access
154
+ βœ… **NoMachine** - High-performance remote desktop (4000/TCP) - **Recommended**
155
+ βœ… **VNC** - Standard VNC access (5900/TCP) - For temporary monitoring only
156
+ βœ… **SSH** - Secure shell access (2222/TCP)
157
+ βœ… **Eye Server** - Screen capture endpoint (4444/TCP)
158
+ βœ… **Task Executor REST API** - Structured task execution for coding agents (9090/TCP)
159
+
160
+ ### Performance & Stability
161
+ βœ… **Fast Boot Time** - Container ready in ~30 seconds
162
+ βœ… **Low CPU Usage** - 20-30% under normal workload
163
+ βœ… **Smooth Performance** - Optimized for regular development tasks
164
+ βœ… **Single Container** - No external files or dependencies
165
+ βœ… **KVM Acceleration** - Hardware virtualization for optimal performance
166
+
167
+ ---
168
+
169
+ ## Container Capabilities
170
+
171
+ ### Operating System
172
+
173
+ **macOS Sequoia 15.7.5**
174
+ - Complete macOS desktop experience
175
+ - Native macOS applications support
176
+ - Standard macOS file system and permissions
177
+ - macOS security features
178
+ - Native macOS APIs and frameworks
179
+
180
+ **Storage Configuration**:
181
+ - **Virtual Disk**: 4TB capacity
182
+ - **Format**: APFS (Apple File System)
183
+ - **RAM**: Fully customizable (minimum 4 GB for smooth operation)
184
+ - **CPU**: Intel i3 configuration (optimized for compatibility)
185
+
186
+ **Pre-installed Applications**:
187
+ - **Browser**: Brave
188
+ - **Editor**: Visual Studio Code
189
+ - **Terminal**: Built-in Terminal app with modern shell tools
190
+ - **File Manager**: Finder
191
+ - **System Utilities**: Standard macOS utilities
192
+
193
+ ### Development Tools
194
+
195
+ #### Programming Languages & Runtimes
196
+
197
+ | Language | Version | Package Manager | Notes |
198
+ |----------|---------|----------------|-------|
199
+ | **Python** | 3.14.4 | pip 26.1 | Default `python` command |
200
+ | **Go** | 1.26.2 | go modules | Full Go development environment |
201
+ | **Rust** | stable | cargo | System-wide installation |
202
+ | **Node.js** | 25.9.0 | npm 11.12.1 | TypeScript & tsx included |
203
+ | **Java** | 25 (latest) | - | Oracle JDK |
204
+ | **C#/.NET** | 10.0 SDK | dotnet | LTS version |
205
+ | **C/C++** | clang/gcc | - | Xcode command line tools |
206
+ | **Kotlin** | 2.3.0 | - | Compiler installed |
207
+ | **Scala** | 3.8.3 | coursier | Latest stable |
208
+ | **PowerShell** | latest | - | Cross-platform shell |
209
+
210
+ #### IDEs & Editors
211
+
212
+ **Visual Studio Code** (latest)
213
+
214
+ Pre-installed extensions:
215
+ - C++ Tools Extension Pack
216
+ - Docker Extension
217
+ - Java Extension Pack
218
+ - Oracle Java Extension
219
+ - .NET Runtime & C# DevKit
220
+ - GitLab Workflow & GitLens
221
+ - Go Extension
222
+ - Python Extension Pack (Pylance, debugpy, environment manager)
223
+ - Rust Analyzer
224
+ - Scala Language Server
225
+
226
+ #### Build Tools & Utilities
227
+
228
+ - **Homebrew** - macOS package manager
229
+ - **Git** (latest) - Version control with LFS support
230
+ - **Xcode Command Line Tools** - Essential development tools
231
+ - **CMake** - Cross-platform build system
232
+ - **GDB** / **LLDB** - Debuggers
233
+
234
+ ### Remote Access
235
+
236
+ #### NoMachine (Port 4000) - **Recommended**
237
+
238
+ **Why NoMachine?**
239
+ - **Best Performance**: Optimized for macOS with hardware acceleration
240
+ - **Low Latency**: Minimal input lag for smooth development experience
241
+ - **High Quality**: Superior video quality with efficient compression
242
+ - **Full Features**: Clipboard sharing, file transfer, audio support
243
+
244
+ **Configuration**:
245
+ - Port: 4000 (TCP)
246
+ - Default remote access method
247
+ - Pre-configured for optimal performance
248
+ - Clipboard sharing enabled
249
+ - Audio support enabled
250
+
251
+ **Use Cases**:
252
+ - Primary development interface
253
+ - Extended coding sessions
254
+ - Full desktop interaction
255
+ - Multi-window workflows
256
+
257
+ #### VNC (Port 5900) - **For Temporary Monitoring Only**
258
+
259
+ **Configuration**:
260
+ - Port: 5900 (TCP)
261
+ - Standard VNC protocol
262
+ - Compatible with any VNC client
263
+
264
+ **Important Notes**:
265
+ - VNC performance is significantly lower than NoMachine
266
+ - Recommended only for temporary monitoring or quick checks
267
+ - Not suitable for extended development sessions
268
+ - Use NoMachine for regular work
269
+
270
+ **Use Cases**:
271
+ - Quick status checks
272
+ - Emergency access when NoMachine is unavailable
273
+ - Automated monitoring scripts
274
+ - Screenshot capture
275
+
276
+ #### SSH (Port 2222)
277
+
278
+ **Configuration**:
279
+ - Port: 2222 (TCP)
280
+ - Secure shell access
281
+ - Terminal-based access to macOS
282
+
283
+ **Use Cases**:
284
+ - Command-line operations
285
+ - File transfers via SCP/SFTP
286
+ - Remote script execution
287
+ - System administration
288
+
289
+ ---
290
+
291
+ ## Technical Specifications
292
+
293
+ ### System Requirements
294
+
295
+ #### Minimum Requirements
296
+
297
+ | Component | Requirement | Notes |
298
+ |-----------|-------------|-------|
299
+ | **RAM** | 6 GB | Absolute minimum for container operation |
300
+ | **Disk Space** | 100 GB free | For container image and virtual disk |
301
+ | **CPU** | 4 cores | x86_64 architecture with KVM support |
302
+ | **Virtualization** | KVM enabled | Hardware virtualization must be enabled in BIOS |
303
+ | **Host OS** | Linux | Ubuntu 20.04+, Debian 11+, or similar |
304
+ | **Docker** | 24.0+ | Recent Docker version required |
305
+ | **Kernel** | 6+ | For proper KVM support |
306
+
307
+ #### Recommended Requirements
308
+
309
+ | Component | Recommendation | Benefit |
310
+ |-----------|---------------|---------|
311
+ | **RAM** | 8 GB | Better performance and headroom |
312
+ | **Disk Space** | 150 GB free | Ample space for projects and data |
313
+ | **CPU** | 4+ cores | Improved responsiveness |
314
+ | **Storage Type** | SSD/NVMe | Faster disk I/O operations |
315
+ | **Network** | 100 Mbps+ | Better remote access experience |
316
+
317
+ ### Container Resource Usage
318
+
319
+ **Runtime Allocations**:
320
+ - **Virtual RAM**: Fully customizable (minimum 4 GB for smooth operation)
321
+ - **Virtual Disk**: 4 TB (APFS filesystem)
322
+ - **Virtual CPU**: Intel i3 configuration
323
+ - **Network**: Bridged networking with port forwarding
324
+
325
+ **Host Resource Impact**:
326
+ - **CPU Usage**: 20-30% under normal workload
327
+ - **Memory Overhead**: ~2-3 GB for container management
328
+ - **Disk I/O**: Moderate (depends on workload)
329
+ - **Network**: Minimal overhead
330
+
331
+ ### Performance Metrics
332
+
333
+ **Boot Performance**:
334
+ - **macOS Boot**: ~30 seconds
335
+ - **Container Start**: Immediate
336
+ - **Desktop Ready**: Immediate after boot completion
337
+
338
+ **Runtime Performance**:
339
+ - **Idle CPU**: 5-10%
340
+ - **Normal Workload CPU**: 20-30%
341
+ - **Memory Usage**: Stable at allocated 8GB
342
+ - **Disk Performance**: Depends on host storage type
343
+
344
+ **Comparison to Alternatives**:
345
+ - **vs. Dockur**: Significantly smoother performance
346
+ - **vs. Docker-OSX**: Better responsiveness and stability
347
+ - **External Files**: None required (vs. multiple external files in alternatives)
348
+ - **Customization**: Fully customizable configuration
349
+ - **State Management**: Clean ephemeral state
350
+
351
+ **Optimization Notes**:
352
+ - Current configuration (Intel i3) is optimized for compatibility and stability
353
+ - Configuration is based on tested and confirmed safe settings
354
+ - Performance can be improved by adjusting CPU configuration to match host hardware
355
+ - Animations may cause slight performance impact with current CPU configuration
356
+ - Heavy animation applications may slow down during transitions
357
+ - Regular development workflows run smoothly without issues
358
+
359
+ ---
360
+
361
+ ## Installation & Deployment
362
+
363
+ ### Prerequisites
364
+
365
+ #### 1. Install Docker
366
+
367
+ **For Ubuntu/Debian**:
368
+ ```bash
369
+ # Update package index
370
+ sudo apt-get update
371
+
372
+ # Install dependencies
373
+ sudo apt-get install -y \
374
+ ca-certificates \
375
+ curl \
376
+ gnupg \
377
+ lsb-release
378
+
379
+ # Add Docker's official GPG key
380
+ sudo mkdir -p /etc/apt/keyrings
381
+ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
382
+
383
+ # Set up the repository
384
+ echo \
385
+ "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
386
+ $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
387
+
388
+ # Install Docker Engine
389
+ sudo apt-get update
390
+ sudo apt-get install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
391
+
392
+ # Verify installation
393
+ docker --version
394
+ docker compose version
395
+ ```
396
+
397
+ **For Other Linux Distributions**:
398
+ ```bash
399
+ # Fedora/RHEL/CentOS
400
+ sudo dnf install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
401
+
402
+ # Arch Linux
403
+ sudo pacman -S docker docker-compose
404
+ ```
405
+
406
+ **Post-Installation Steps**:
407
+ ```bash
408
+ # Add your user to docker group (to run docker without sudo)
409
+ sudo usermod -aG docker $USER
410
+
411
+ # Enable Docker service
412
+ sudo systemctl enable docker
413
+ sudo systemctl start docker
414
+
415
+ # Log out and log back in for group changes to take effect
416
+ ```
417
+
418
+ #### 2. Enable KVM
419
+
420
+ **Check KVM Support**:
421
+ ```bash
422
+ # Check if KVM is supported
423
+ lscpu | grep Virtualization
424
+
425
+ # Check if KVM modules are loaded
426
+ lsmod | grep kvm
427
+
428
+ # Expected output:
429
+ # kvm_intel (for Intel CPUs) or kvm_amd (for AMD CPUs)
430
+ # kvm
431
+ ```
432
+
433
+ **Enable KVM**:
434
+ ```bash
435
+ # Install KVM packages (Ubuntu/Debian)
436
+ sudo apt-get install -y qemu-kvm libvirt-daemon-system libvirt-clients bridge-utils
437
+
438
+ # For Fedora/RHEL/CentOS
439
+ sudo dnf install -y qemu-kvm libvirt virt-install bridge-utils
440
+
441
+ # Verify KVM is working
442
+ sudo kvm-ok
443
+
444
+ # Expected output:
445
+ # INFO: /dev/kvm exists
446
+ # KVM acceleration can be used
447
+ ```
448
+
449
+ **Set KVM Permissions**:
450
+ ```bash
451
+ # Add user to kvm group
452
+ sudo usermod -aG kvm $USER
453
+
454
+ # Verify /dev/kvm permissions
455
+ ls -l /dev/kvm
456
+
457
+ # Should show: crw-rw---- 1 root kvm
458
+
459
+ # Log out and log back in for group changes to take effect
460
+ ```
461
+
462
+ **Verify KVM Access**:
463
+ ```bash
464
+ # After logging back in, verify you can access KVM
465
+ groups | grep kvm
466
+
467
+ # Test KVM device access
468
+ test -r /dev/kvm && test -w /dev/kvm && echo "KVM is accessible" || echo "KVM access denied"
469
+ ```
470
+
471
+ **If KVM is Not Enabled in BIOS**:
472
+ 1. Restart your computer
473
+ 2. Enter BIOS/UEFI settings (usually F2, F10, F12, or Del key during boot)
474
+ 3. Look for virtualization settings:
475
+ - Intel: "Intel VT-x" or "Intel Virtualization Technology"
476
+ - AMD: "AMD-V" or "SVM Mode"
477
+ 4. Enable the setting
478
+ 5. Save and exit BIOS
479
+ 6. Boot into Linux and verify with `kvm-ok`
480
+
481
+ ### Docker Compose Deployment
482
+
483
+ **Recommended Deployment Method**: The **ONLY** recommended way to run this container is using Docker Compose. This ensures proper configuration and port mappings.
484
+
485
+ #### 1. Create Docker Compose File
486
+
487
+ Create a file named `deploy-macos.yaml`:
488
+
489
+ ```yaml
490
+ services:
491
+ mac-agent:
492
+ image: nullvoider/mac15-base:v1
493
+ container_name: mac_agent
494
+ restart: unless-stopped
495
+ tty: true
496
+ stdin_open: true
497
+ ports:
498
+ - 4000:4000 # NoMachine (recommended remote access)
499
+ - 4444:4445 # Eye server
500
+ - 2222:2222 # SSH
501
+ - 5900:5900 # VNC (temporary monitoring only)
502
+ - 9090:9090 # Task Executor REST API
503
+ environment:
504
+ - API_TOKEN=your-secret-token
505
+ - TASK_MAX_AGE=3600
506
+ devices:
507
+ - /dev/kvm:/dev/kvm
508
+ cap_add:
509
+ - NET_ADMIN
510
+ extra_hosts:
511
+ - "host.docker.internal:host-gateway"
512
+ ```
513
+
514
+ #### 2. Deploy the Container
515
+
516
+ ```bash
517
+ # Start the container
518
+ docker compose -f deploy-macos.yaml up -d
519
+
520
+ # View logs
521
+ docker compose -f deploy-macos.yaml logs -f
522
+
523
+ # Check container status
524
+ docker compose -f deploy-macos.yaml ps
525
+ ```
526
+
527
+ #### 3. Container Management
528
+
529
+ ```bash
530
+ # Stop the container
531
+ docker compose -f deploy-macos.yaml stop
532
+
533
+ # Start the container
534
+ docker compose -f deploy-macos.yaml start
535
+
536
+ # Restart the container
537
+ docker compose -f deploy-macos.yaml restart
538
+
539
+ # Remove the container
540
+ docker compose -f deploy-macos.yaml down
541
+
542
+ # Remove container and volumes
543
+ docker compose -f deploy-macos.yaml down -v
544
+ ```
545
+
546
+ ### Testing the Container
547
+
548
+ #### 1. Verify Container is Running
549
+
550
+ ```bash
551
+ # Check container status
552
+ docker ps | grep mac_agent
553
+
554
+ # Expected output:
555
+ # CONTAINER ID IMAGE STATUS PORTS
556
+ # abc123def456 nullvoider/mac15-base:v1 Up 2 minutes 0.0.0.0:4000->4000/tcp, ...
557
+ ```
558
+
559
+ #### 2. Check Boot Progress
560
+
561
+ ```bash
562
+ # Monitor container logs
563
+ docker logs -f mac_agent
564
+
565
+ # Look for successful boot messages indicating:
566
+ # - macOS boot sequence completed
567
+ # - Services started
568
+ # - NoMachine server ready
569
+ # - VNC server ready
570
+ ```
571
+
572
+ #### 3. Test Remote Access
573
+
574
+ **NoMachine (Recommended)**:
575
+ ```bash
576
+ # Connect using NoMachine client to:
577
+ # Host: your-server-ip
578
+ # Port: 4000
579
+ ```
580
+
581
+ **VNC (Temporary)**:
582
+ ```bash
583
+ # Connect using any VNC client to:
584
+ # Host: your-server-ip
585
+ # Port: 5900
586
+ ```
587
+
588
+ **SSH**:
589
+ ```bash
590
+ # Test SSH connection
591
+ ssh -p 2222 user@your-server-ip
592
+ ```
593
+
594
+ #### 4. Verify Services
595
+
596
+ Once connected via NoMachine or VNC:
597
+ 1. Open Terminal
598
+ 2. Check system information: `sw_vers`
599
+ 3. Verify development tools: `python --version`, `node --version`, etc.
600
+ 4. Open VS Code to verify it's installed
601
+
602
+ #### 5. Health Check
603
+
604
+ ```bash
605
+ # Check container resource usage
606
+ docker stats mac_agent
607
+
608
+ # Expected metrics:
609
+ # CPU: 20-30% (normal workload)
610
+ # MEM: ~4GB allocated
611
+ # NET I/O: Varies based on remote access usage
612
+ ```
613
+
614
+ ---
615
+
616
+ ## Customizing the Image
617
+
618
+ This section walks through the full process of modifying the macOS environment and rebuilding a custom Docker image β€” useful for adding languages, tools, updated scripts, or any workflow-specific configurations and customizations.
619
+
620
+ ### Prerequisites
621
+
622
+ - Repository cloned with QCOW2 downloaded (see [Getting Started](#getting-started))
623
+ - Docker and QEMU utilities installed (`qemu-img` must be on PATH)
624
+ - At least 100 GB free disk space for the conversion steps
625
+
626
+ ---
627
+
628
+ ### Step 1 β€” Modify the YAML Configuration (Optional)
629
+
630
+ If you need to adjust the RAM or CPU core allocation before booting into macOS, edit the YAML file inside the `scripts/` directory of the cloned repo:
631
+
632
+ ```bash
633
+ # Example: open and edit the YAML before moving it
634
+ nano scripts/mac15.yaml
635
+ ```
636
+
637
+ Then move it to a separate working directory of your choice β€” this directory will be your build workspace for all subsequent steps:
638
+
639
+ ```bash
640
+ mv scripts/mac15.yaml /your/working/directory/
641
+ ```
642
+
643
+ > ⚠️ **WARNING**: Only change RAM and CPU core values in the YAML. **Do not change the disk size** β€” altering the disk size will corrupt `data.img` and make it unusable. If that happens, you will need to re-run Step 2 from the original QCOW2 file to start over.
644
+
645
+ ---
646
+
647
+ ### Step 2 β€” Convert the QCOW2 to a Raw Image
648
+
649
+ From the root of the cloned repository, convert the QCOW2 disk image to a raw format that QEMU can use as a mutable disk:
650
+
651
+ ```bash
652
+ qemu-img convert -p -f qcow2 -O raw mac15-image/mac15.qcow2 data.img
653
+ ```
654
+
655
+ This may take several minutes depending on your disk speed. The `-p` flag shows progress.
656
+
657
+ ---
658
+
659
+ ### Step 3 β€” Create the macOS Directory Structure
660
+
661
+ Navigate to the working directory where you moved the YAML file and create the expected directory layout:
662
+
663
+ ```bash
664
+ cd /your/working/directory
665
+ mkdir macos
666
+ mkdir macos/15
667
+ ```
668
+
669
+ ---
670
+
671
+ ### Step 4 β€” Place the Disk Images
672
+
673
+ Copy or move `base.dmg` and the `data.img` produced in Step 2 into the directory you just created:
674
+
675
+ ```bash
676
+ # Copy (safe β€” preserves originals)
677
+ cp /path/to/base.dmg macos/15/base.dmg
678
+ cp /path/to/data.img macos/15/data.img
679
+
680
+ # Or move (saves disk space if originals are no longer needed)
681
+ mv /path/to/data.img macos/15/data.img
682
+ ```
683
+
684
+ ---
685
+
686
+ ### Step 5 β€” Boot and Customize
687
+
688
+ Start the container from your working directory:
689
+
690
+ ```bash
691
+ docker compose -f mac15.yaml up -d
692
+ ```
693
+
694
+ Connect via NoMachine or VNC and perform your customizations inside the running macOS environment β€” updating the Task Executor script, installing apps, adding programming languages, configuring tools, or anything else your workflow requires.
695
+
696
+ ---
697
+
698
+ ### Step 6 β€” Clean Up Before Capture
699
+
700
+ Before shutting down, ensure the macOS environment is clean so no personal or session data ends up in your image:
701
+
702
+ - **Browser**: Close all tabs and clear all browsing history, cookies, and cached data in every browser installed
703
+ - **Terminal**: Wipe shell history β€” in the terminal run `history -c && > ~/.zsh_history && > ~/.bash_history`
704
+ - **Recent items**: Clear recent files, recent apps, and recent servers from the Apple menu β†’ Recent Items β†’ Clear Menu
705
+ - **Trash**: Empty the Trash
706
+
707
+ ---
708
+
709
+ ### Step 7 β€” Shut Down and Stop the Container
710
+
711
+ Shut down macOS cleanly from within the OS (Apple menu β†’ Shut Down) and wait for the guest to fully power off. Then, from the host terminal in your working directory:
712
+
713
+ ```bash
714
+ docker compose -f mac15.yaml down
715
+ ```
716
+
717
+ ---
718
+
719
+ ### Step 8 β€” Convert Back to QCOW2
720
+
721
+ From the `macos/15/` directory, convert the modified raw image back to a compressed QCOW2:
722
+
723
+ ```bash
724
+ cd macos/15
725
+ qemu-img convert -p -O qcow2 -c data.img mac15.qcow2
726
+ ```
727
+
728
+ The `-c` flag enables compression to keep the image size manageable. This step may take several minutes.
729
+
730
+ ---
731
+
732
+ ### Step 9 β€” Move the QCOW2 to the Build Directory
733
+
734
+ Move the new QCOW2 back into the `mac15-image/` directory of the cloned repository. If a QCOW2 already exists there, remove it first:
735
+
736
+ ```bash
737
+ # Remove existing if present
738
+ rm /path/to/cloned-repo/mac15-image/mac15.qcow2
739
+
740
+ # Move new QCOW2 into place
741
+ mv macos/15/mac15.qcow2 /path/to/cloned-repo/mac15-image/mac15.qcow2
742
+ ```
743
+
744
+ ---
745
+
746
+ ### Step 10 β€” Build Your Custom Image
747
+
748
+ From the root of the cloned repository, build the Docker image with your chosen tag:
749
+
750
+ ```bash
751
+ docker build -f mac15-base.dockerfile -t <username>/<image-name>:<version-number> .
752
+ ```
753
+
754
+ Example:
755
+ ```bash
756
+ docker build -f mac15-base.dockerfile -t myorg/mac15-custom:v1 .
757
+ ```
758
+
759
+ Once the build completes, clear the Docker builder cache to avoid storage bloat:
760
+
761
+ ```bash
762
+ docker builder prune --all
763
+ ```
764
+
765
+ Your custom image is ready to use in your workflow.
766
+
767
+ ---
768
+
769
+ ## Installed Software
770
+
771
+ ### Pre-installed Applications
772
+
773
+ #### Productivity & Development
774
+ - **Brave Browser** - Privacy-focused web browser (default)
775
+ - **Visual Studio Code** - Feature-rich code editor with extensions
776
+ - **Terminal** - Built-in macOS terminal with modern shell tools
777
+
778
+ #### System Utilities
779
+ - **Finder** - macOS file manager
780
+ - **System Preferences** - macOS settings
781
+ - **Activity Monitor** - System resource monitoring
782
+ - **Console** - System log viewer
783
+
784
+ ### Command Line Tools
785
+
786
+ #### Package Managers
787
+ - **Homebrew** - macOS package manager
788
+ - **pip** - Python package manager
789
+ - **npm** - Node.js package manager
790
+ - **cargo** - Rust package manager
791
+ - **go modules** - Go dependency management
792
+
793
+ #### Development Utilities
794
+ - **git** - Version control (with Git LFS)
795
+ - **zsh** - Z shell (default shell)
796
+ - **tmux** - Terminal multiplexer
797
+ - **vim** / **nano** - Text editors
798
+
799
+ #### Build Tools
800
+ - **Xcode Command Line Tools** - Essential development tools
801
+ - **gcc** / **clang** - C/C++ compilers
802
+ - **make** - Build automation
803
+ - **cmake** - Cross-platform build system
804
+
805
+ ---
806
+
807
+ ## Development Environments
808
+
809
+ ### Python Development
810
+ ```bash
811
+ # Python 3.14.4 pre-installed
812
+ python --version
813
+
814
+ # Install packages
815
+ pip install numpy pandas tensorflow
816
+
817
+ # Virtual environments
818
+ python -m venv myenv
819
+ source myenv/bin/activate
820
+ ```
821
+
822
+ ### Node.js Development
823
+ ```bash
824
+ # Node.js 25.9.0 pre-installed
825
+ node --version
826
+ npm --version
827
+
828
+ # Install packages
829
+ npm install -g typescript tsx
830
+
831
+ # Project setup
832
+ npm init -y
833
+ npm install express
834
+ ```
835
+
836
+ ### Go Development
837
+ ```bash
838
+ # Go 1.26.2 pre-installed
839
+ go version
840
+
841
+ # Initialize module
842
+ go mod init myproject
843
+
844
+ # Install dependencies
845
+ go get github.com/gin-gonic/gin
846
+ ```
847
+
848
+ ### Rust Development
849
+ ```bash
850
+ # Rust stable pre-installed
851
+ rustc --version
852
+ cargo --version
853
+
854
+ # Create new project
855
+ cargo new myproject
856
+ cd myproject
857
+ cargo build
858
+ ```
859
+
860
+ ### Java Development
861
+ ```bash
862
+ # Java 25 pre-installed
863
+ java --version
864
+ javac --version
865
+
866
+ # Compile and run
867
+ javac HelloWorld.java
868
+ java HelloWorld
869
+ ```
870
+
871
+ ### C#/.NET Development
872
+ ```bash
873
+ # .NET 10.0 SDK pre-installed
874
+ dotnet --version
875
+
876
+ # Create new project
877
+ dotnet new console -n MyApp
878
+ cd MyApp
879
+ dotnet run
880
+ ```
881
+
882
+ ### iOS/macOS Development
883
+ ```bash
884
+ # Xcode command line tools available
885
+ xcode-select --version
886
+
887
+ # Build tools
888
+ xcodebuild -version
889
+ ```
890
+
891
+ ---
892
+
893
+ ## The-Eye Integration
894
+
895
+ The Eye is an AI-native vision capture tool integrated into the macOS container, providing automated screen capture capabilities for Computer Use Agent training, monitoring, and debugging.
896
+
897
+ ### Overview
898
+
899
+ The Eye captures screen content at configurable intervals for:
900
+ - **Agent Training**: Collect visual data for training CUAs, train coding agents with full environment rather than a partial one and also evaluate agents in a full OS environments
901
+ - **Debugging**: Record agent interactions for troubleshooting
902
+ - **Monitoring**: Track agent behavior during execution
903
+ - **Dataset Creation**: Build machine learning datasets from screen captures
904
+
905
+ ### Configuration
906
+
907
+ **Eye Server Port**: 8080 (HTTP)
908
+ **Architecture**: Client-server model with RESTful API
909
+ **Storage**: In-memory circular buffer (configurable capacity)
910
+
911
+ **Important Note**: The Eye server configuration is specific to the macOS container. Server port and settings differ from the Ubuntu build, though core functionality remains the same.
912
+
913
+ ### Connection & Endpoints
914
+
915
+ **Eye Server Base URL**:
916
+ ```
917
+ http://your-server-ip:8080
918
+ ```
919
+
920
+ **Available Endpoints**:
921
+ - `GET /health` - Server health status and metrics
922
+ - `GET /snapshot.png` - Retrieve latest captured frame
923
+ - `POST /upload` - Upload captured frames (for external agents)
924
+ - `POST /admin/config` - Update capture configuration
925
+ - `GET /debug` - Server runtime statistics
926
+
927
+ ### Python SDK
928
+
929
+ The Eye includes a Python SDK for programmatic access:
930
+
931
+ **Installation** (if not using container's built-in Eye):
932
+ ```bash
933
+ pip install eye-capture
934
+ ```
935
+
936
+ **Basic Usage**:
937
+ ```python
938
+ from eye.core import EyeClient
939
+
940
+ # Connect to Eye server
941
+ client = EyeClient("http://localhost:8080", token="your-token")
942
+
943
+ # Health check
944
+ health = client.health_check()
945
+
946
+ # Get latest screenshot
947
+ image_data = client.get_snapshot()
948
+ with open("screenshot.png", "wb") as f:
949
+ f.write(image_data)
950
+
951
+ # Get frame metadata
952
+ metadata = client.get_snapshot_metadata()
953
+ print(f"Frame ID: {metadata['frame_id']}")
954
+
955
+ # Get debug info
956
+ debug = client.get_debug_info()
957
+ print(f"Uptime: {debug['uptime_sec']}s")
958
+ ```
959
+
960
+ **Advanced Features**:
961
+ ```python
962
+ from eye.core import EyeClient, SessionManager
963
+ from eye.integrations import DatasetExporter
964
+
965
+ # Initialize components
966
+ client = EyeClient("http://localhost:8080", token="TOKEN")
967
+ exporter = DatasetExporter()
968
+
969
+ # Capture session
970
+ for i in range(100):
971
+ frame = client.get_snapshot()
972
+ metadata = client.get_snapshot_metadata()
973
+ exporter.add_frame(frame, i, metadata)
974
+ time.sleep(1.5)
975
+
976
+ # Export dataset
977
+ exporter.export_json("training_data.json")
978
+ exporter.export_csv("training_data.csv")
979
+ ```
980
+
981
+ ### Key Features
982
+
983
+ **Capture Capabilities**:
984
+ - Multiple image formats (PNG, JPEG, WebP, BMP, TIFF)
985
+ - Configurable quality (1-100)
986
+ - Adjustable capture interval (0.1s minimum)
987
+ - Automatic retries with exponential backoff
988
+
989
+ **API Features**:
990
+ - RESTful HTTP endpoints
991
+ - Token authentication
992
+ - Dynamic configuration updates
993
+ - Health monitoring
994
+ - Debug statistics
995
+
996
+ **Integration Options**:
997
+ - Python SDK for programmatic access
998
+ - REST API for any language
999
+ - Dataset export (JSON, JSONL, CSV)
1000
+ - Webhook support for event notifications
1001
+ - Cloud storage integration patterns
1002
+
1003
+ ### Quick Usage Examples
1004
+
1005
+ **REST API (curl)**:
1006
+ ```bash
1007
+ # Get latest screenshot
1008
+ curl http://localhost:8080/snapshot.png > screenshot.png
1009
+
1010
+ # Check health
1011
+ curl http://localhost:8080/health
1012
+
1013
+ # Update configuration
1014
+ curl -X POST http://localhost:8080/admin/config \
1015
+ -H "Authorization: Bearer your-token" \
1016
+ -d '{"interval": 2.0, "format": "jpeg", "quality": 85}'
1017
+ ```
1018
+
1019
+ **Python SDK**:
1020
+ ```python
1021
+ from eye.core import EyeClient
1022
+
1023
+ client = EyeClient("http://localhost:8080")
1024
+
1025
+ # Continuous monitoring
1026
+ while True:
1027
+ snapshot = client.get_snapshot()
1028
+ # Process snapshot for agent training
1029
+ process_for_training(snapshot)
1030
+ time.sleep(1.5)
1031
+ ```
1032
+
1033
+ ### Performance Impact
1034
+
1035
+ - **CPU Overhead**: <3% during capture
1036
+ - **Memory Usage**: 50-150 MB (in-memory buffer)
1037
+ - **Network Bandwidth**: 0.5-2 MB/s @ 1.5s interval
1038
+ - **Capture Latency**: 10-50ms (platform dependent)
1039
+ - **Display Performance**: No noticeable impact on macOS GUI
1040
+
1041
+ ### Configuration Options
1042
+
1043
+ The Eye service runs automatically when the container starts. Configure via API:
1044
+
1045
+ ```python
1046
+ import requests
1047
+
1048
+ # Update capture settings
1049
+ response = requests.post(
1050
+ "http://localhost:8080/admin/config",
1051
+ headers={"Authorization": "Bearer your-token"},
1052
+ json={
1053
+ "interval": 2.0, # Capture every 2 seconds
1054
+ "format": "jpeg", # Use JPEG format
1055
+ "quality": 85 # 85% quality
1056
+ }
1057
+ )
1058
+ ```
1059
+
1060
+ **For more details**, see The Eye documentation: https://github.com/nullvoider07/the-eyes
1061
+
1062
+ ---
1063
+
1064
+ ## Task Executor REST API
1065
+
1066
+ The Task Executor is a Flask/waitress HTTP service running directly inside the macOS QEMU guest, exposed on **port 9090** via QEMU port-forwarding. It provides structured task submission and result retrieval for coding agents and evaluation harnesses, including SWE-bench Lite compatibility.
1067
+
1068
+ ### Architecture
1069
+
1070
+ ```
1071
+ [external client]
1072
+ β”‚ HTTP port 9090
1073
+ β–Ό
1074
+ [QEMU port-forward hostfwd tcp::9090-:9090]
1075
+ β–Ό
1076
+ [Flask service β€” running natively inside macOS guest]
1077
+ β”‚ subprocess / native macOS calls
1078
+ β–Ό
1079
+ [git, python3, pytest β€” all native on macOS]
1080
+ ```
1081
+
1082
+ **Important**: `docker exec` cannot reach the macOS QEMU guest. All task execution must go through this REST API or SSH (port 2222). Never use `docker exec mac_agent <cmd>` to run commands inside macOS.
1083
+
1084
+ ### Service Setup (one-time, via SSH)
1085
+
1086
+ ```bash
1087
+ # 1. Copy files into the guest
1088
+ scp -P 2222 task_executor.py AgentUser@localhost:/Users/AgentUser/tasks/
1089
+ scp -P 2222 com.cua.taskexecutor.plist AgentUser@localhost:/Users/AgentUser/tasks/
1090
+
1091
+ # 2. SSH in and complete setup
1092
+ ssh -p 2222 AgentUser@localhost
1093
+
1094
+ # 3. Install dependencies
1095
+ pip3 install flask waitress
1096
+
1097
+ # 4. Register as a launchd system service (auto-starts on boot)
1098
+ sudo cp /Users/AgentUser/tasks/com.cua.taskexecutor.plist /Library/LaunchDaemons/
1099
+ sudo chown root:wheel /Library/LaunchDaemons/com.cua.taskexecutor.plist
1100
+ sudo chmod 644 /Library/LaunchDaemons/com.cua.taskexecutor.plist
1101
+
1102
+ # 5. Start immediately without rebooting
1103
+ sudo launchctl load /Library/LaunchDaemons/com.cua.taskexecutor.plist
1104
+ ```
1105
+
1106
+ Service logs are written to `/Users/AgentUser/tasks/task_executor.log`.
1107
+
1108
+ ### Endpoints
1109
+
1110
+ #### POST /task/submit
1111
+
1112
+ Submit a task for execution. Returns immediately with a task ID.
1113
+
1114
+ **Request body**:
1115
+ ```json
1116
+ {
1117
+ "repo_url": "https://github.com/org/repo",
1118
+ "base_commit": "abc1234",
1119
+ "patch": "--- a/file.py\n+++ b/file.py\n...",
1120
+ "test_command": "python3 -m pytest tests/ -x --tb=short",
1121
+ "timeout": 300,
1122
+ "lint_command": "ruff check . --output-format json",
1123
+ "capture_diff": true,
1124
+ "reference_patch": "--- a/file.py\n+++ b/file.py\n..."
1125
+ }
1126
+ ```
1127
+
1128
+ | Field | Required | Default | Description |
1129
+ |---|---|---|---|
1130
+ | `repo_url` | βœ… | β€” | Git-clonable URL |
1131
+ | `base_commit` | ❌ | `HEAD` | Commit, tag, or branch to check out |
1132
+ | `patch` | ❌ | β€” | Unified diff applied after checkout |
1133
+ | `test_command` | βœ… | β€” | Command run in the repo root |
1134
+ | `timeout` | ❌ | `300` | Seconds before the process is killed |
1135
+ | `lint_command` | ❌ | β€” | CLI lint command run after tests; result is a soft score only |
1136
+ | `capture_diff` | ❌ | `false` | Capture `git diff <base_commit>` after tests |
1137
+ | `reference_patch` | ❌ | β€” | Ground-truth unified diff for patch similarity scoring |
1138
+
1139
+ **Response** `202 Accepted`:
1140
+ ```json
1141
+ { "task_id": "550e8400-e29b-41d4-a716-446655440000", "status": "pending" }
1142
+ ```
1143
+
1144
+ #### GET /task/{id}
1145
+
1146
+ Lightweight status poll β€” no stdout/stderr payload.
1147
+
1148
+ **Response** `200`:
1149
+ ```json
1150
+ { "task_id": "...", "status": "pending|running|completed|failed" }
1151
+ ```
1152
+
1153
+ #### GET /task/{id}/result
1154
+
1155
+ Full result once the task completes. Returns `202` while still running.
1156
+
1157
+ **Response** `200`:
1158
+ ```json
1159
+ {
1160
+ "task_id": "...",
1161
+ "status": "completed",
1162
+ "exit_code": 0,
1163
+ "stdout": "...",
1164
+ "stderr": "...",
1165
+ "tests_passed": 5,
1166
+ "tests_failed": 0,
1167
+ "lint_errors": 2,
1168
+ "lint_output": "Found 2 errors.",
1169
+ "patch_diff": "diff --git a/src/foo.py ...",
1170
+ "patch_similarity": 0.9412,
1171
+ "execution_time": 14.2
1172
+ }
1173
+ ```
1174
+
1175
+ #### DELETE /task/{id}
1176
+
1177
+ Remove a task record from the store.
1178
+
1179
+ **Response** `200`:
1180
+ ```json
1181
+ { "task_id": "...", "deleted": true }
1182
+ ```
1183
+
1184
+ ### SWE-bench Lite Compatibility
1185
+
1186
+ The task executor is designed to be compatible with the [SWE-bench Lite](https://github.com/princeton-nlp/SWE-bench) evaluation harness:
1187
+
1188
+ - **Clean workspace per task**: Each task runs in its own UUID subdirectory (`/Users/AgentUser/tasks/<uuid>/repo/`). No git state is shared between tasks β€” no VM reboot required.
1189
+ - **Pinned base commit**: The `base_commit` field maps directly to the SWE-bench instance's `base_commit`.
1190
+ - **Patch application**: The `patch` field accepts a standard unified diff, applied via `git apply` after checkout.
1191
+ - **pytest execution**: `test_command` accepts any pytest invocation; pass/fail counts are parsed from output automatically.
1192
+ - **Structured results**: Exit code, stdout, stderr, pass/fail counts, and execution time are all returned in a single JSON response.
1193
+ **Example SWE-bench task submission**:
1194
+ ```bash
1195
+ curl -X POST http://localhost:9090/task/submit \
1196
+ -H "Content-Type: application/json" \
1197
+ -d '{
1198
+ "repo_url": "https://github.com/psf/requests",
1199
+ "base_commit": "a1b2c3d4",
1200
+ "patch": "<unified diff from SWE-bench instance>",
1201
+ "test_command": "python3 -m pytest tests/test_requests.py -x --tb=short",
1202
+ "timeout": 600
1203
+ }'
1204
+ ```
1205
+
1206
+ ### Supported Test Frameworks
1207
+
1208
+ The executor auto-detects the test framework from `test_command` and routes to the appropriate parser.
1209
+
1210
+ | `test_command` contains | Framework | Output parsed |
1211
+ |------------------------|-----------|--------------|
1212
+ | `pytest`, `py.test` | pytest | `5 passed, 2 failed, 1 error in 3.14s` |
1213
+ | `cargo` | cargo test | `test result: ok. 5 passed; 0 failed` |
1214
+ | `go test` | go test | `--- PASS/FAIL:` lines; `ok`/`FAIL` package lines |
1215
+ | `jest`, `npm test`, `yarn test`, `pnpm test` | Jest | `Tests: 2 failed, 5 passed, 7 total` |
1216
+ | `dotnet` | dotnet test | `Failed: 2, Passed: 3, Total: 5` |
1217
+ | `mvn`, `gradle`, `sbt`, `junit` | JUnit/Surefire | `Tests run: 7, Failures: 2, Errors: 0` |
1218
+
1219
+ For unrecognised commands, all parsers are tried in order and the first non-zero result is used.
1220
+
1221
+ ### Supported Linters (Soft Score)
1222
+
1223
+ Lint results are recorded in `lint_errors` and `lint_output` but **never** change `status` or `exit_code`. This is consistent with SWE-bench, HumanEval, and LiveCodeBench conventions.
1224
+
1225
+ | Linter | Language | Example `lint_command` |
1226
+ |--------|----------|------------------------|
1227
+ | `ruff` | Python | `ruff check . --output-format json` |
1228
+ | `flake8` | Python | `flake8 src/` |
1229
+ | `mypy` | Python | `mypy src/ --ignore-missing-imports` |
1230
+ | `pylint` | Python | `pylint src/` |
1231
+ | `cargo clippy` | Rust | `cargo clippy -- -D warnings` |
1232
+ | `eslint` | JS/TS | `eslint src/ --format json` |
1233
+ | `go vet` | Go | `go vet ./...` |
1234
+ | `clang-tidy` | C/C++ | `clang-tidy src/*.cpp` |
1235
+ | `dotnet build` | C# | `dotnet build --no-restore` |
1236
+
1237
+ ### API Authentication
1238
+
1239
+ When `API_TOKEN` is set (via environment variable in the macOS guest or the Docker Compose file), every request must include:
1240
+
1241
+ ```
1242
+ Authorization: Bearer <token>
1243
+ ```
1244
+
1245
+ Requests without a valid token return `401 Unauthorized`. Set it via SSH before starting the executor:
1246
+
1247
+ ```bash
1248
+ ssh -p 2222 AgentUser@localhost
1249
+ export API_TOKEN=your-secret-token
1250
+ python3 /Users/AgentUser/tasks/task_executor.py &
1251
+ ```
1252
+
1253
+ Or set it persistently in the launchd plist:
1254
+ ```xml
1255
+ <key>EnvironmentVariables</key>
1256
+ <dict>
1257
+ <key>API_TOKEN</key>
1258
+ <string>your-secret-token</string>
1259
+ <key>TASK_MAX_AGE</key>
1260
+ <string>3600</string>
1261
+ </dict>
1262
+ ```
1263
+
1264
+ ### Cleanup After Testing
1265
+
1266
+ To remove all traces of the task executor from the macOS guest:
1267
+
1268
+ ```bash
1269
+ ssh -p 2222 AgentUser@localhost
1270
+
1271
+ # Stop and unload the service
1272
+ sudo launchctl unload /Library/LaunchDaemons/com.cua.taskexecutor.plist
1273
+
1274
+ # Remove the plist
1275
+ sudo rm /Library/LaunchDaemons/com.cua.taskexecutor.plist
1276
+
1277
+ # Remove the script, log, and any remaining task directories
1278
+ rm -rf /Users/AgentUser/tasks
1279
+
1280
+ # Uninstall dependencies
1281
+ pip3 uninstall flask waitress -y
1282
+ ```
1283
+
1284
+ ---
1285
+
1286
+ ## Remote Access Methods
1287
+
1288
+ ### NoMachine (Recommended)
1289
+
1290
+ **Primary Remote Access Method**: NoMachine provides the best performance and user experience for macOS container access.
1291
+
1292
+ #### Why NoMachine?
1293
+
1294
+ **Performance Benefits**:
1295
+ - Hardware-accelerated rendering
1296
+ - Optimized for macOS GUI
1297
+ - Low latency input handling
1298
+ - Efficient bandwidth usage
1299
+ - Superior video quality
1300
+
1301
+ **Features**:
1302
+ - Full desktop experience
1303
+ - Clipboard sharing (bidirectional)
1304
+ - File transfer capabilities
1305
+ - Audio support
1306
+ - Multi-session support
1307
+ - Keyboard and mouse optimization
1308
+
1309
+ #### Connection Setup
1310
+
1311
+ **1. Install NoMachine Client**:
1312
+ - Download from: https://www.nomachine.com/download
1313
+ - Available for Windows, macOS, Linux
1314
+
1315
+ **2. Create Connection**:
1316
+ ```
1317
+ Protocol: NX
1318
+ Host: your-server-ip
1319
+ Port: 4000
1320
+ ```
1321
+
1322
+ **3. Connect**:
1323
+ - Open NoMachine client
1324
+ - Select the connection
1325
+ - Connect to macOS desktop
1326
+
1327
+ #### Best Practices
1328
+
1329
+ **For Best Performance**:
1330
+ - Use wired network connection when possible
1331
+ - Close unused applications in the container
1332
+ - Disable unnecessary animations in macOS settings
1333
+ - Use NoMachine's adaptive quality settings
1334
+
1335
+ **Network Requirements**:
1336
+ - Minimum: 10 Mbps
1337
+ - Recommended: 100 Mbps+
1338
+ - Latency: <50ms for best experience
1339
+
1340
+ #### Use Cases
1341
+
1342
+ **Primary Development**:
1343
+ - Extended coding sessions
1344
+ - Full IDE usage (VS Code, Xcode)
1345
+ - Multi-window workflows
1346
+ - GUI application development
1347
+
1348
+ **Testing & Debugging**:
1349
+ - Interactive debugging
1350
+ - Visual testing
1351
+ - GUI automation development
1352
+ - Screen recording
1353
+
1354
+ ### VNC (Temporary Monitoring)
1355
+
1356
+ **Important**: VNC should **ONLY** be used for temporary monitoring. Performance is significantly inferior to NoMachine.
1357
+
1358
+ #### When to Use VNC
1359
+
1360
+ **Appropriate Use Cases**:
1361
+ - Quick status checks
1362
+ - Emergency access when NoMachine is unavailable
1363
+ - Automated monitoring scripts
1364
+ - Screenshot capture for monitoring
1365
+
1366
+ **Not Recommended For**:
1367
+ - Primary development work
1368
+ - Extended sessions
1369
+ - Resource-intensive applications
1370
+ - High-quality video requirements
1371
+
1372
+ #### Connection Setup
1373
+
1374
+ **1. Use Any VNC Client**:
1375
+ - TigerVNC
1376
+ - RealVNC
1377
+ - TightVNC
1378
+ - Built-in VNC clients (macOS Screen Sharing)
1379
+
1380
+ **2. Connect**:
1381
+ ```
1382
+ Host: your-server-ip:5900
1383
+ or
1384
+ Host: your-server-ip
1385
+ Port: 5900
1386
+ ```
1387
+
1388
+ #### Performance Comparison
1389
+
1390
+ | Aspect | NoMachine | VNC |
1391
+ |--------|-----------|-----|
1392
+ | Video Quality | Excellent | Moderate |
1393
+ | Latency | Very Low | Higher |
1394
+ | Bandwidth Usage | Optimized | Higher |
1395
+ | CPU Usage | Low | Higher |
1396
+ | Features | Full | Basic |
1397
+ | **Recommendation** | **Primary Use** | **Emergency Only** |
1398
+
1399
+ ### SSH Access
1400
+
1401
+ **Port**: 2222
1402
+
1403
+ #### Connection
1404
+
1405
+ ```bash
1406
+ # Basic SSH connection
1407
+ ssh -p 2222 username@your-server-ip
1408
+
1409
+ # With key authentication
1410
+ ssh -i ~/.ssh/id_rsa -p 2222 username@your-server-ip
1411
+
1412
+ # Port forwarding example
1413
+ ssh -L 8080:localhost:8080 -p 2222 username@your-server-ip
1414
+ ```
1415
+
1416
+ #### Use Cases
1417
+
1418
+ **Command-Line Operations**:
1419
+ - Script execution
1420
+ - Package installation
1421
+ - System administration
1422
+ - Log viewing
1423
+
1424
+ **File Transfer**:
1425
+ ```bash
1426
+ # Copy files to container
1427
+ scp -P 2222 file.txt username@your-server-ip:/path/to/destination
1428
+
1429
+ # Copy files from container
1430
+ scp -P 2222 username@your-server-ip:/path/to/file.txt ./
1431
+
1432
+ # Using rsync
1433
+ rsync -avz -e "ssh -p 2222" ./local-dir username@your-server-ip:/remote-dir
1434
+ ```
1435
+
1436
+ **Remote Script Execution**:
1437
+ ```bash
1438
+ # Execute single command
1439
+ ssh -p 2222 username@your-server-ip "python3 script.py"
1440
+
1441
+ # Execute multiple commands
1442
+ ssh -p 2222 username@your-server-ip << 'EOF'
1443
+ cd /path/to/project
1444
+ git pull
1445
+ python3 script.py
1446
+ EOF
1447
+ ```
1448
+
1449
+ ---
1450
+
1451
+ ## Troubleshooting
1452
+
1453
+ ### Common Issues
1454
+
1455
+ #### 1. Dock Not Appearing
1456
+
1457
+ **Symptoms**:
1458
+ - macOS dock is missing after boot
1459
+ - Desktop appears but dock doesn't load
1460
+ - Dock was visible before but disappeared
1461
+
1462
+ **Causes**:
1463
+ - Docker not releasing RAM/CPU completely
1464
+ - macOS process management issue
1465
+ - System resource constraints
1466
+
1467
+ **Solutions**:
1468
+
1469
+ **Option 1: Restart Container** (Try This First)
1470
+ ```bash
1471
+ # Stop the container
1472
+ docker compose -f deploy-macos.yaml stop
1473
+
1474
+ # Wait 10 seconds
1475
+ sleep 10
1476
+
1477
+ # Start the container
1478
+ docker compose -f deploy-macos.yaml start
1479
+
1480
+ # Monitor logs
1481
+ docker logs -f mac_agent
1482
+ ```
1483
+
1484
+ **Option 2: Restart Docker Service**
1485
+ ```bash
1486
+ # Restart Docker service
1487
+ sudo systemctl restart docker
1488
+
1489
+ # Wait for Docker to fully restart
1490
+ sleep 15
1491
+
1492
+ # Start the container
1493
+ docker compose -f deploy-macos.yaml up -d
1494
+ ```
1495
+
1496
+ **Option 3: System Restart** (If Above Don't Work)
1497
+ ```bash
1498
+ # If Docker doesn't release resources properly, a system restart may be necessary
1499
+ sudo reboot
1500
+ ```
1501
+
1502
+ **Prevention**:
1503
+ - Ensure adequate system RAM free (8GB recommended)
1504
+ - Don't run too many containers simultaneously
1505
+ - Monitor host system resources regularly
1506
+ - Perform clean container shutdowns
1507
+
1508
+ #### 2. Slow Performance During Animations
1509
+
1510
+ **Symptoms**:
1511
+ - Lag during window transitions
1512
+ - Slow animations
1513
+ - Choppy GUI movements
1514
+ - Applications with heavy animations slow down other apps
1515
+
1516
+ **Cause**:
1517
+ - Intel i3 CPU configuration limits animation performance
1518
+ - Current configuration optimized for stability, not animation speed
1519
+
1520
+ **Solutions**:
1521
+
1522
+ **Option 1: Reduce Animations in macOS**
1523
+ 1. Open System Preferences
1524
+ 2. Go to Accessibility β†’ Display
1525
+ 3. Enable "Reduce motion"
1526
+ 4. Disable "Reduce transparency" if needed
1527
+
1528
+ **Option 2: Close Animation-Heavy Applications**
1529
+ - Avoid running multiple apps with complex animations
1530
+ - Close unnecessary applications
1531
+ - Focus on development tools without heavy UI effects
1532
+
1533
+ **Option 3: Configuration Adjustment** (Advanced)
1534
+ - The current i3 configuration is based on tested and confirmed settings
1535
+ - Configuration can be customized for better animation performance
1536
+ - Requires understanding of system limits and testing
1537
+ - Contact for configuration guidance if needed
1538
+
1539
+ **Note**:
1540
+ - Regular development workloads run smoothly
1541
+ - Issue only affects excessive animation scenarios
1542
+ - Normal coding, browsing, and terminal work unaffected
1543
+
1544
+ #### 3. Container Won't Start
1545
+
1546
+ **Symptoms**:
1547
+ - Container exits immediately after start
1548
+ - Error messages in logs
1549
+ - Container status shows "Exited"
1550
+
1551
+ **Diagnostic Steps**:
1552
+ ```bash
1553
+ # Check container logs
1554
+ docker logs mac_agent
1555
+
1556
+ # Check container status
1557
+ docker ps -a | grep mac_agent
1558
+
1559
+ # Inspect container
1560
+ docker inspect mac_agent
1561
+ ```
1562
+
1563
+ **Common Solutions**:
1564
+
1565
+ **KVM Not Available**:
1566
+ ```bash
1567
+ # Verify KVM is accessible
1568
+ ls -l /dev/kvm
1569
+
1570
+ # Check if you're in kvm group
1571
+ groups | grep kvm
1572
+
1573
+ # Add user to kvm group if missing
1574
+ sudo usermod -aG kvm $USER
1575
+ # Log out and back in
1576
+ ```
1577
+
1578
+ **Insufficient Resources**:
1579
+ ```bash
1580
+ # Check available RAM
1581
+ free -h
1582
+
1583
+ # Check disk space
1584
+ df -h
1585
+
1586
+ # Verify at least 4GB RAM available
1587
+ ```
1588
+
1589
+ **Port Conflicts**:
1590
+ ```bash
1591
+ # Check if ports are already in use
1592
+ sudo netstat -tlnp | grep -E '4000|4444|2222|5900|9090'
1593
+
1594
+ # Stop conflicting services or change ports in docker-compose.yaml
1595
+ ```
1596
+
1597
+ #### 4. Remote Access Connection Issues
1598
+
1599
+ **NoMachine Won't Connect**:
1600
+ ```bash
1601
+ # Verify port is exposed
1602
+ docker port mac_agent 4000
1603
+
1604
+ # Check if service is listening
1605
+ docker exec mac_agent netstat -an | grep 4000
1606
+
1607
+ # Test connectivity from host
1608
+ telnet localhost 4000
1609
+ ```
1610
+
1611
+ **VNC Not Working**:
1612
+ ```bash
1613
+ # Check VNC port
1614
+ docker port mac_agent 5900
1615
+
1616
+ # Verify VNC server is running
1617
+ docker exec mac_agent ps aux | grep vnc
1618
+ ```
1619
+
1620
+ **SSH Connection Refused**:
1621
+ ```bash
1622
+ # Check SSH port mapping
1623
+ docker port mac_agent 2222
1624
+
1625
+ # Verify SSH service
1626
+ docker exec mac_agent ps aux | grep sshd
1627
+ ```
1628
+
1629
+ #### 5. macOS-Specific Issues
1630
+
1631
+ **Standard macOS Troubleshooting Applies**:
1632
+
1633
+ Most macOS-related issues can be resolved using standard macOS troubleshooting methods:
1634
+
1635
+ 1. **System Preferences Reset**:
1636
+ - Open System Preferences
1637
+ - Reset specific settings causing issues
1638
+ - Restart affected applications
1639
+
1640
+ 2. **Application Issues**:
1641
+ - Force quit misbehaving applications
1642
+ - Clear application caches
1643
+ - Reinstall problematic applications via Homebrew
1644
+
1645
+ 3. **Disk Issues**:
1646
+ - Run Disk Utility
1647
+ - Verify and repair disk if needed
1648
+ - Check available storage space
1649
+
1650
+ 4. **Permission Issues**:
1651
+ - Reset permissions in System Preferences
1652
+ - Use `chmod` and `chown` as needed
1653
+ - Check application permissions in Security & Privacy
1654
+
1655
+ **These are standard macOS issues, not container-specific problems**.
1656
+
1657
+ ### Getting Help
1658
+
1659
+ If you encounter issues not covered here:
1660
+
1661
+ 1. **Check container logs**: `docker logs mac_agent`
1662
+ 2. **Review system resources**: Ensure minimum requirements are met
1663
+ 3. **Verify KVM access**: Confirm `/dev/kvm` is accessible
1664
+ 4. **Test connectivity**: Check network and port accessibility
1665
+ 5. **See Reporting Issues section** for how to get support
1666
+
1667
+ ---
1668
+
1669
+ ## CI/CD Integration
1670
+
1671
+ The macOS container is designed for seamless integration into CI/CD pipelines, particularly for Computer Use Agent development and deployment.
1672
+
1673
+ **IMPORTANT**: When deploying this container in CI/CD pipelines or production environments, ensure compliance with Apple's Software License Agreement (EULA) for macOS. Commercial or enterprise deployments may require additional licensing from Apple.
1674
+
1675
+ ### Supported Platforms
1676
+
1677
+ **Container Orchestration**:
1678
+ - βœ… **Docker** - Native Docker deployment
1679
+ - βœ… **Kubernetes** - K8s pod deployment
1680
+ - βœ… **Docker Compose** - Multi-container orchestration
1681
+ - βœ… **Docker Swarm** - Swarm service deployment
1682
+
1683
+ **CI/CD Systems**:
1684
+ - GitHub Actions
1685
+ - GitLab CI/CD
1686
+ - Jenkins
1687
+ - CircleCI
1688
+ - Travis CI
1689
+ - Any system supporting Docker
1690
+
1691
+ ### Docker-Based CI/CD
1692
+
1693
+ #### GitHub Actions CI/CD Example
1694
+
1695
+ ```yaml
1696
+ name: Agent macOS Tests
1697
+
1698
+ on: [push, pull_request]
1699
+
1700
+ jobs:
1701
+ test:
1702
+ runs-on: ubuntu-latest
1703
+
1704
+ steps:
1705
+ - uses: actions/checkout@v3
1706
+
1707
+ - name: Set up KVM
1708
+ run: |
1709
+ sudo apt-get update
1710
+ sudo apt-get install -y qemu-kvm libvirt-daemon-system
1711
+ sudo usermod -aG kvm $USER
1712
+
1713
+ - name: Start macOS Container
1714
+ run: |
1715
+ docker compose -f deploy-macos.yaml up -d
1716
+ sleep 90 # Wait for macOS boot and task executor to be ready
1717
+
1718
+ - name: Submit task via REST API
1719
+ run: |
1720
+ # The task executor runs inside the macOS QEMU guest.
1721
+ # Use the REST API on port 9090 β€” docker exec cannot reach the guest.
1722
+ TASK_ID=$(curl -s -X POST http://localhost:9090/task/submit \
1723
+ -H "Content-Type: application/json" \
1724
+ -d '{
1725
+ "repo_url": "https://github.com/your-org/your-repo",
1726
+ "base_commit": "main",
1727
+ "test_command": "python3 -m pytest tests/ -x --tb=short",
1728
+ "timeout": 300
1729
+ }' | python3 -c "import sys,json; print(json.load(sys.stdin)['task_id'])")
1730
+ echo "TASK_ID=$TASK_ID" >> $GITHUB_ENV
1731
+
1732
+ - name: Poll for result
1733
+ run: |
1734
+ for i in $(seq 1 60); do
1735
+ STATUS=$(curl -s http://localhost:9090/task/$TASK_ID | python3 -c "import sys,json; print(json.load(sys.stdin)['status'])")
1736
+ echo "Status: $STATUS"
1737
+ if [ "$STATUS" = "completed" ] || [ "$STATUS" = "failed" ]; then
1738
+ break
1739
+ fi
1740
+ sleep 5
1741
+ done
1742
+ curl -s http://localhost:9090/task/$TASK_ID/result | python3 -m json.tool
1743
+
1744
+ - name: Cleanup
1745
+ if: always()
1746
+ run: docker compose -f deploy-macos.yaml down
1747
+ ```
1748
+
1749
+ #### GitLab CI Example
1750
+
1751
+ ```yaml
1752
+ stages:
1753
+ - test
1754
+
1755
+ macos_tests:
1756
+ stage: test
1757
+ image: docker:latest
1758
+ services:
1759
+ - docker:dind
1760
+ variables:
1761
+ DOCKER_DRIVER: overlay2
1762
+ before_script:
1763
+ - docker info
1764
+ script:
1765
+ - docker compose -f deploy-macos.yaml up -d
1766
+ - sleep 90
1767
+ - |
1768
+ TASK_ID=$(curl -s -X POST http://localhost:9090/task/submit \
1769
+ -H "Content-Type: application/json" \
1770
+ -d '{"repo_url":"https://github.com/your-org/your-repo","test_command":"python3 -m pytest tests/ -x","timeout":300}' \
1771
+ | python3 -c "import sys,json; print(json.load(sys.stdin)['task_id'])")
1772
+ - sleep 30
1773
+ - curl -s http://localhost:9090/task/$TASK_ID/result | python3 -m json.tool
1774
+ after_script:
1775
+ - docker compose -f deploy-macos.yaml down
1776
+ tags:
1777
+ - kvm
1778
+ ```
1779
+
1780
+ ### Kubernetes Deployment
1781
+
1782
+ #### Pod Specification
1783
+
1784
+ ```yaml
1785
+ apiVersion: v1
1786
+ kind: Pod
1787
+ metadata:
1788
+ name: macos-agent
1789
+ labels:
1790
+ app: macos-base
1791
+ spec:
1792
+ containers:
1793
+ - name: mac-agent
1794
+ image: nullvoider/mac15-base:v1
1795
+ ports:
1796
+ - containerPort: 4000
1797
+ name: nomachine
1798
+ - containerPort: 4444
1799
+ name: eye-server
1800
+ - containerPort: 2222
1801
+ name: ssh
1802
+ - containerPort: 5900
1803
+ name: vnc
1804
+ - containerPort: 9090
1805
+ name: task-executor
1806
+ securityContext:
1807
+ capabilities:
1808
+ add:
1809
+ - NET_ADMIN
1810
+ volumeMounts:
1811
+ - name: kvm
1812
+ mountPath: /dev/kvm
1813
+ volumes:
1814
+ - name: kvm
1815
+ hostPath:
1816
+ path: /dev/kvm
1817
+ type: CharDevice
1818
+ restartPolicy: Always
1819
+ ```
1820
+
1821
+ #### Deployment with Service
1822
+
1823
+ ```yaml
1824
+ apiVersion: apps/v1
1825
+ kind: Deployment
1826
+ metadata:
1827
+ name: macos-agent-deployment
1828
+ spec:
1829
+ replicas: 1
1830
+ selector:
1831
+ matchLabels:
1832
+ app: macos-base
1833
+ template:
1834
+ metadata:
1835
+ labels:
1836
+ app: macos-base
1837
+ spec:
1838
+ containers:
1839
+ - name: mac-agent
1840
+ image: nullvoider/mac15-base:v1
1841
+ ports:
1842
+ - containerPort: 4000
1843
+ - containerPort: 4444
1844
+ - containerPort: 2222
1845
+ - containerPort: 5900
1846
+ - containerPort: 9090
1847
+ ---
1848
+ apiVersion: v1
1849
+ kind: Service
1850
+ metadata:
1851
+ name: macos-agent-service
1852
+ spec:
1853
+ selector:
1854
+ app: macos-base
1855
+ ports:
1856
+ - name: nomachine
1857
+ port: 4000
1858
+ targetPort: 4000
1859
+ - name: eye
1860
+ port: 4444
1861
+ targetPort: 4444
1862
+ - name: ssh
1863
+ port: 2222
1864
+ targetPort: 2222
1865
+ - name: vnc
1866
+ port: 5900
1867
+ targetPort: 5900
1868
+ - name: task-executor
1869
+ port: 9090
1870
+ targetPort: 9090
1871
+ type: LoadBalancer
1872
+ ```
1873
+
1874
+ ### Use Cases
1875
+
1876
+ **Computer Use Agent Development**:
1877
+ - Automated testing of CUA implementations
1878
+ - Training data collection in reproducible environments
1879
+ - Performance benchmarking
1880
+ - Integration testing
1881
+
1882
+ **macOS Application Testing**:
1883
+ - Cross-platform application testing
1884
+ - macOS-specific feature validation
1885
+ - GUI automation testing
1886
+ - Compatibility verification
1887
+
1888
+ **Continuous Integration**:
1889
+ - Automated builds on macOS environment
1890
+ - Unit testing with macOS dependencies
1891
+ - Integration testing with macOS services
1892
+ - End-to-end testing workflows
1893
+
1894
+ ### Best Practices
1895
+
1896
+ **Resource Management**:
1897
+ ```yaml
1898
+ # Kubernetes resource limits
1899
+ resources:
1900
+ requests:
1901
+ memory: "4Gi"
1902
+ cpu: "4"
1903
+ limits:
1904
+ memory: "8Gi"
1905
+ cpu: "8"
1906
+ ```
1907
+
1908
+ **Health Checks**:
1909
+ ```yaml
1910
+ # Kubernetes liveness probe
1911
+ livenessProbe:
1912
+ exec:
1913
+ command:
1914
+ - /bin/bash
1915
+ - -c
1916
+ - "pgrep -f NoMachine"
1917
+ initialDelaySeconds: 120
1918
+ periodSeconds: 30
1919
+ ```
1920
+
1921
+ **Cleanup Strategy**:
1922
+ - Always use `docker compose down` or equivalent cleanup
1923
+ - Implement timeout for long-running tests
1924
+ - Monitor resource usage during CI runs
1925
+ - Use ephemeral runners when possible
1926
+
1927
+ ---
1928
+
1929
+ ## Reporting Issues
1930
+
1931
+ When reporting issues, please provide comprehensive information to help diagnose and resolve problems quickly.
1932
+
1933
+ ### Bug Reports
1934
+
1935
+ **Required Information**:
1936
+
1937
+ 1. **Environment Details**:
1938
+ ```bash
1939
+ # Docker version
1940
+ docker --version
1941
+ docker compose version
1942
+
1943
+ # Host OS information
1944
+ cat /etc/os-release
1945
+ uname -a
1946
+
1947
+ # KVM information
1948
+ kvm-ok
1949
+ ls -l /dev/kvm
1950
+ ```
1951
+
1952
+ 2. **System Resources**:
1953
+ ```bash
1954
+ # Available RAM
1955
+ free -h
1956
+
1957
+ # Disk space
1958
+ df -h
1959
+
1960
+ # CPU information
1961
+ lscpu
1962
+ ```
1963
+
1964
+ 3. **Container Logs**:
1965
+ ```bash
1966
+ # Full container logs
1967
+ docker logs mac_agent > container-logs.txt
1968
+
1969
+ # Last 200 lines
1970
+ docker logs --tail 200 mac_agent
1971
+
1972
+ # Real-time logs
1973
+ docker logs -f mac_agent
1974
+ ```
1975
+
1976
+ 4. **Container Status**:
1977
+ ```bash
1978
+ # Container details
1979
+ docker ps -a | grep mac_agent
1980
+ docker inspect mac_agent
1981
+
1982
+ # Resource usage
1983
+ docker stats mac_agent --no-stream
1984
+ ```
1985
+
1986
+ 5. **Steps to Reproduce**:
1987
+ - Detailed steps to reproduce the issue
1988
+ - Expected behavior
1989
+ - Actual behavior
1990
+ - Screenshots or screen recordings if applicable
1991
+
1992
+ 6. **Configuration**:
1993
+ - Docker Compose file contents
1994
+ - Any custom modifications
1995
+ - Environment variables used
1996
+
1997
+ ### Feature Requests
1998
+
1999
+ **Required Information**:
2000
+
2001
+ 1. **Use Case Description**:
2002
+ - What problem does this feature solve?
2003
+ - Who would benefit from this feature?
2004
+ - How urgent is this feature?
2005
+
2006
+ 2. **Proposed Implementation**:
2007
+ - How should the feature work?
2008
+ - What configuration options should it have?
2009
+ - Any technical considerations?
2010
+
2011
+ 3. **Impact Assessment**:
2012
+ - How would this affect existing functionality?
2013
+ - Resource implications (CPU, RAM, disk)?
2014
+ - Compatibility considerations?
2015
+
2016
+ 4. **Alternatives Considered**:
2017
+ - What alternatives have you considered?
2018
+ - Why is this approach preferred?
2019
+
2020
+ ### Contact Information
2021
+
2022
+ **For Direct Support**:
2023
+ - **X (Twitter)**: [@nullvoider07](https://x.com/nullvoider07)
2024
+
2025
+ **When Reporting**:
2026
+ - Be specific and detailed
2027
+ - Include all requested information
2028
+ - Attach logs and screenshots
2029
+ - Describe impact and urgency
2030
+
2031
+ ---
2032
+
2033
+ ## FAQ
2034
+
2035
+ ### Coding Agent Evaluation Questions
2036
+
2037
+ **Q: What new eval capabilities were added in v1?**
2038
+ A: The Task Executor API now supports `lint_command` (soft-score linting), `capture_diff` (records `git diff <base_commit>` after the test run), and `reference_patch` (ground-truth unified diff for patch similarity scoring returning a 0.0–1.0 ratio). Multi-framework test scoring covers pytest, cargo, go test, jest, dotnet, and JUnit/Maven/Gradle/sbt β€” auto-detected from `test_command`. See the [Task Executor REST API](#task-executor-rest-api) section for full field reference.
2039
+
2040
+ **Q: Why is lint scoring soft β€” why doesn't it fail the task?**
2041
+ A: The majority of established coding benchmarks (SWE-bench, HumanEval, LiveCodeBench) use test pass/fail as the primary correctness signal. Lint errors reflect code quality but not functional correctness. Keeping lint as a soft score lets you track quality trends without invalidating otherwise correct solutions.
2042
+
2043
+ **Q: What is patch_similarity and when is it useful?**
2044
+ A: It is a 0.0–1.0 similarity ratio between the agent's actual diff and a ground-truth reference patch, computed after stripping all unified diff metadata (file paths, line numbers, git object hashes). Most useful for patch-apply evals where a canonical solution exists. Always interpret alongside `tests_passed` β€” a lower similarity score does not mean the solution is wrong.
2045
+
2046
+ **Q: How do I access the Task Executor API remotely from outside the container?**
2047
+ A: The Task Executor runs inside the macOS QEMU guest and is forwarded to the Docker host via QEMU's `hostfwd` on port 9090. From outside the host, it is reachable at `http://your-server-ip:9090` as long as port 9090 is exposed in the Compose file (which it is by default). Always set `API_TOKEN` when the port is reachable outside a trusted network boundary.
2048
+
2049
+ **Q: In a k8s deployment with many replicas, how does an orchestrator target a specific pod?**
2050
+ A: Each replica runs its own Task Executor with its own in-memory task store. The orchestrator must track the pod IP (or headless service DNS entry) at submission time and send all status/result polls to the same pod β€” a load-balanced service may route to a different replica and return `404 Task not found`. Use a headless k8s service to get per-pod DNS entries, or record the pod IP at submission time.
2051
+
2052
+ **Q: What happens to in-flight tasks if a pod is evicted or restarted?**
2053
+ A: Tasks are in-memory inside the macOS guest and are lost on restart. The macOS container's ~4-second boot means recovery is fast, but the orchestrator must still implement retry logic and treat `404 Task not found` as a signal to resubmit.
2054
+
2055
+ **Q: How do I pass API_TOKEN securely in a k8s deployment?**
2056
+ A: Mount it as a k8s Secret and inject it into the launchd plist environment via an init container or startup script. Never hardcode tokens in the Compose file or Dockerfile:
2057
+ ```yaml
2058
+ env:
2059
+ - name: API_TOKEN
2060
+ valueFrom:
2061
+ secretKeyRef:
2062
+ name: task-executor-secret
2063
+ key: api-token
2064
+ ```
2065
+
2066
+ **Q: Can the Task Executor run tasks in parallel?**
2067
+ A: Yes β€” each submitted task runs in an independent background thread with its own isolated UUID workspace under `/Users/AgentUser/tasks/`. Tasks never share git state. For large-scale parallelism, deploy multiple container replicas via k8s; each replica maintains its own in-memory store.
2068
+
2069
+ ### General Questions
2070
+
2071
+ **Q: Can I use this container for coding agent evaluation like SWE-bench?**
2072
+ A: Yes. The Task Executor REST API (port 9090) provides exactly the interface needed: submit a repo URL, base commit, patch, and test command; poll for status; retrieve structured results including exit code, stdout, stderr, and pytest pass/fail counts. Each task gets an isolated UUID workspace so concurrent tasks and sequential tasks never share state. See the [Task Executor REST API](#task-executor-rest-api) section for full setup and usage.
2073
+
2074
+ **Q: Why can't I use `docker exec mac_agent <command>` to run commands inside macOS?**
2075
+ A: This container runs macOS inside a QEMU virtual machine. `docker exec` executes commands on the Ubuntu Docker host layer, not inside the macOS guest. To run commands in macOS, use SSH on port 2222 or the Task Executor REST API on port 9090.
2076
+
2077
+ **Q: How is the entire macOS system running in a single container?**
2078
+ A: This container uses advanced virtualization techniques with KVM acceleration to run a complete macOS system. Unlike Dockur and Docker-OSX which require multiple external files and complex setups, this build has everything self-contained within the container image, the result is a fully functional macOS 15.7.5 environment that's completely isolated and ephemeral.
2079
+
2080
+ **Q: Why doesn't this container need external files like Dockur and Docker-OSX?**
2081
+ A: The container architecture was designed from the ground up to be self-contained. All necessary components, including the macOS system files, bootloader, and configuration, are embedded within the container image itself. This provides significant advantages: easier deployment, cleaner state management, no external file dependencies, and true ephemeral operation.
2082
+
2083
+ **Q: What makes this container different from Docker-OSX and Dockur?**
2084
+ A: Several key differences:
2085
+ - **No External Files**: Everything is self-contained in the container
2086
+ - **Better Performance**: 20-30% CPU usage vs higher overhead in alternatives
2087
+ - **Smoother Operation**: Optimized for stability and responsiveness
2088
+ - **Ephemeral State**: Clean isolation without external dependencies
2089
+ - **Simpler Deployment**: Just Docker Compose, no complex file management
2090
+ - **Customizable**: Configuration can be tuned for specific hardware
2091
+
2092
+ **Q: Can I run multiple instances of this container?**
2093
+ A: Yes, but each instance requires 4GB of RAM. Ensure your host has sufficient resources (e.g., 8GB+ RAM for 2 instances).
2094
+
2095
+ **Q: How much disk space does it need?**
2096
+ A: The container image requires approximately 100GB of host disk space. The macOS system inside has a 4TB virtual disk.
2097
+
2098
+ **Q: Is this suitable for production use?**
2099
+ A: Yes, it's specifically designed for Computer Use Agent development and deployment in production environments. The container provides a stable, reproducible macOS environment ideal for CI/CD pipelines and automated testing. **Important**: For production use, ensure compliance with Apple's Software License Agreement (EULA), as commercial deployment of macOS may have specific licensing requirements.
2100
+
2101
+ ### Performance Questions
2102
+
2103
+ **Q: What is the boot time?**
2104
+ A: The container is ready in approximately 30 seconds β€” the macOS system and all services (NoMachine, Task Executor, Eye) are live immediately after the container starts. This is one of the key advantages over Dockur and Docker-OSX alternatives.
2105
+
2106
+ **Q: Can I improve the performance?**
2107
+ A: Yes, the current Intel i3 CPU configuration can be customized for better performance based on your hardware. The existing configuration prioritizes stability and compatibility. For better animation performance, you can adjust the CPU configuration, though this requires testing on your specific hardware.
2108
+
2109
+ **Q: Why does NoMachine perform better than VNC?**
2110
+ A: NoMachine uses hardware acceleration, optimized protocols, and better compression algorithms specifically designed for remote desktop performance. VNC uses a more basic protocol that's less efficient for macOS GUI rendering.
2111
+
2112
+ **Q: What's the CPU usage under heavy load?**
2113
+ A: Under normal development workloads (coding, browsing, terminal work), expect 20-30% CPU. Heavy compilation or animation-intensive applications may increase this to 40-50%.
2114
+
2115
+ ### Compatibility Questions
2116
+
2117
+ **Q: Does it work on Windows/macOS hosts?**
2118
+ A: It requires a Linux host with KVM support. Windows (WSL2 with nested virtualization) and macOS hosts are not officially supported due to KVM requirements.
2119
+
2120
+ **Q: What Linux distributions are supported?**
2121
+ A: Any modern Linux distribution with Docker 24.0+ and KVM support:
2122
+ - Ubuntu 20.04+
2123
+ - Debian 11+
2124
+ - Fedora 36+
2125
+ - CentOS 8+
2126
+ - Arch Linux
2127
+
2128
+ **Q: Can I use AMD CPUs?**
2129
+ A: Yes, as long as AMD-V (SVM) is enabled in BIOS and the KVM kernel modules are loaded.
2130
+
2131
+ **Q: What about ARM processors (Apple Silicon)?**
2132
+ A: Not supported. This is an x86_64 container designed for Intel/AMD processors only.
2133
+
2134
+ ### Configuration Questions
2135
+
2136
+ **Q: Can I change the RAM allocation?**
2137
+ A: The container is configured for 4GB RAM. Changing this requires rebuilding the container image with modified configuration. This is not recommended without thorough testing.
2138
+
2139
+ **Q: How do I add more software to the container?**
2140
+ A: Use Homebrew inside the running container:
2141
+ ```bash
2142
+ brew install package-name
2143
+ ```
2144
+ For persistence, create a custom image based on this one.
2145
+
2146
+ **Q: Can I use this for iOS app development?**
2147
+ A: Xcode command line tools are available, but full Xcode IDE may require additional configuration. The container is optimized for Computer Use Agent development.
2148
+
2149
+ **Q: How do I persist data across container restarts?**
2150
+ A: Use Docker volumes to mount directories from the host:
2151
+ ```yaml
2152
+ volumes:
2153
+ - ./my-projects:/Users/username/projects
2154
+ ```
2155
+
2156
+ ### Remote Access Questions
2157
+
2158
+ **Q: Why can't I use VNC for development work?**
2159
+ A: VNC performance is significantly lower than NoMachine. It's suitable only for monitoring or quick checks. For actual development work, the lag and lower frame rate make it impractical.
2160
+
2161
+ **Q: Can I use other remote desktop solutions?**
2162
+ A: The container is pre-configured with NoMachine and VNC. Adding other solutions would require custom configuration.
2163
+
2164
+ **Q: What's the bandwidth requirement for NoMachine?**
2165
+ A: Minimum 10 Mbps, recommended 100 Mbps+ for best experience. Less bandwidth will work but may impact video quality.
2166
+
2167
+ ### Troubleshooting Questions
2168
+
2169
+ **Q: The dock isn't appearing. What should I do?**
2170
+ A: First try restarting the container. If that doesn't work, restart the Docker service. In rare cases, a system restart may be needed to fully release resources.
2171
+
2172
+ **Q: Why are animations slow?**
2173
+ A: The Intel i3 CPU configuration prioritizes stability. You can reduce animations in macOS settings or customize the CPU configuration for better animation performance.
2174
+
2175
+ **Q: How do I access container logs?**
2176
+ A:
2177
+ ```bash
2178
+ docker logs mac_agent
2179
+ docker logs -f mac_agent # Follow mode
2180
+ ```
2181
+
2182
+ **Q: The container won't start. What's wrong?**
2183
+ A: Check:
2184
+ 1. KVM is accessible (`ls -l /dev/kvm`)
2185
+ 2. Sufficient RAM available (8GB free)
2186
+ 3. Ports aren't conflicting
2187
+ 4. Docker service is running
2188
+ 5. Container logs for specific errors
2189
+
2190
+ ### Security Questions
2191
+
2192
+ **Q: Is this container secure?**
2193
+ A: The container runs with NET_ADMIN capability and requires KVM access. It's designed for development environments. For production, review security considerations and implement appropriate network isolation.
2194
+
2195
+ **Q: Can I run this in a public cloud?**
2196
+ A: Only on infrastructure that exposes hardware virtualization extensions to the guest. Bare-metal instances work universally. Standard VM instances require the cloud provider to explicitly enable nested virtualization β€” AWS Nitro, Google Cloud, and Azure support it on select instance types, but it must be enabled per-instance and is not on by default. The limiting factor is the hypervisor configuration, not the host OS.
2197
+
2198
+ **Q: How do I secure remote access?**
2199
+ A: Use VPN or SSH tunneling to access the container:
2200
+ ```bash
2201
+ ssh -L 4000:localhost:4000 -p 2222 host-server
2202
+ ```
2203
+ Then connect NoMachine to `localhost:4000`.
2204
+
2205
+ ---
2206
+
2207
+ ## License
2208
+
2209
+ This project is licensed under the **GNU General Public License v3.0 (GPL-3.0)** for the container infrastructure, configuration, and custom components. However, macOS and Apple software are subject to Apple's Software License Agreement.
2210
+
2211
+ ### License Scope
2212
+
2213
+ **GPL-3.0 Applies To**:
2214
+ - Container configuration files and Docker Compose setup
2215
+ - Custom scripts and automation tools created by the developer
2216
+ - Integration code and custom components
2217
+ - Documentation and setup instructions
2218
+ - Any modifications you make to these components
2219
+
2220
+ **GPL-3.0 Does NOT Apply To**:
2221
+ - macOS operating system (proprietary Apple software under Apple EULA)
2222
+ - Apple applications and frameworks
2223
+ - Third-party commercial software included in the container
2224
+ - Other third-party software with their own licenses
2225
+
2226
+ ### GPL-3.0 License Summary
2227
+
2228
+ **Permissions** (for GPL-3.0 covered components only):
2229
+ - βœ… Commercial use
2230
+ - βœ… Modification
2231
+ - βœ… Distribution
2232
+ - βœ… Patent use
2233
+ - βœ… Private use
2234
+
2235
+ **Conditions** (for GPL-3.0 covered components):
2236
+ - πŸ“‹ License and copyright notice
2237
+ - πŸ“‹ State changes
2238
+ - πŸ“‹ Disclose source
2239
+ - πŸ“‹ Same license (copyleft)
2240
+
2241
+ **Limitations**:
2242
+ - ❌ Liability
2243
+ - ❌ Warranty
2244
+
2245
+ ### Apple EULA Requirements
2246
+
2247
+ **IMPORTANT**: By using this container, you agree to comply with Apple's Software License Agreement for macOS. Key requirements include:
2248
+
2249
+ - macOS is licensed, not sold
2250
+ - Use restrictions apply based on Apple's EULA
2251
+ - Commercial deployment may require additional Apple licenses
2252
+ - Redistribution of macOS is subject to Apple's terms
2253
+ - You are responsible for ensuring EULA compliance
2254
+
2255
+ ### What This Means for Users
2256
+
2257
+ **For the Container Infrastructure** (GPL-3.0):
2258
+ - You can use, modify, and distribute the container configuration
2259
+ - You can create derivative works of the setup scripts
2260
+ - If you distribute modified versions, you must:
2261
+ - Include the GPL-3.0 license
2262
+ - Make your source code modifications available
2263
+ - License your modifications under GPL-3.0
2264
+ - Document any changes made
2265
+
2266
+ **For macOS and Apple Software** (Apple EULA):
2267
+ - You must comply with Apple's Software License Agreement
2268
+ - Review Apple's EULA before commercial use
2269
+ - Some use cases may require Apple's approval or additional licensing
2270
+ - You are solely responsible for EULA compliance
2271
+
2272
+ **Combined Usage**:
2273
+ When using this container, you must comply with BOTH:
2274
+ 1. GPL-3.0 for container infrastructure components
2275
+ 2. Apple's EULA for macOS and Apple software
2276
+
2277
+ The developer provides the container infrastructure under GPL-3.0 but cannot grant rights to macOS itselfβ€”those rights come from Apple's EULA.
2278
+
2279
+ ### Full Licenses
2280
+
2281
+ - **GPL-3.0**: https://www.gnu.org/licenses/gpl-3.0.en.html
2282
+ - **Apple EULA**: https://www.apple.com/legal/sla/
2283
+
2284
+ ### Disclaimer
2285
+
2286
+ This container is provided "as is" without warranty of any kind. The developer is not affiliated with Apple Inc. Users are responsible for ensuring their use complies with all applicable licenses and laws.
2287
+
2288
+ ---
2289
+
2290
+ ## About This Project
2291
+
2292
+ The **macOS 15.7.5 Container** represents a significant advancement in containerized macOS environments. Built for Computer Use Agent development and frontier coding agent evaluation, this project addresses the key challenges faced by developers working with macOS-based automation and AI agents.
2293
+
2294
+ Version 2 extends the original CUA environment into a full coding agent evaluation platform. The Task Executor API β€” covering multi-framework test scoring, programmatic lint integration, diff capture, and ground-truth patch similarity scoring β€” was designed to support rigorous benchmarking on a native macOS runtime, enabling SWE-bench-style workflows and broader eval harness compatibility on Apple's platform.
2295
+
2296
+ ### Project Goals
2297
+
2298
+ **Primary Objectives**:
2299
+ - Provide a reproducible macOS environment for CUA development
2300
+ - Eliminate external file dependencies for cleaner deployments
2301
+ - Optimize performance while maintaining stability
2302
+ - Enable seamless CI/CD integration for macOS workflows
2303
+ - Support scalable agent training and testing
2304
+
2305
+ **Design Philosophy**:
2306
+ - **Self-Contained**: Everything in one container, no external files
2307
+ - **Ephemeral**: Clean state management with proper isolation
2308
+ - **Performant**: Optimized for real-world development workflows
2309
+ - **Tested**: Based on confirmed safe and stable configurations
2310
+ - **Accessible**: Simple deployment with Docker Compose
2311
+
2312
+ ### Development Journey
2313
+
2314
+ This container was built from the ground up through:
2315
+ - Extensive testing on real hardware
2316
+ - Iterative performance optimization
2317
+ - Configuration tuning for stability
2318
+ - Integration of development tools
2319
+ - Refinement of remote access methods
2320
+
2321
+ Every configuration choice, from the Intel i3 CPU setting to the customizable RAM allocation, is based on tested and confirmed performance characteristics. The current configuration represents what can be safely delivered and has been verified to work reliably.
2322
+
2323
+ ### Why This Matters
2324
+
2325
+ **For Developers**:
2326
+ - Consistent macOS environment across team members
2327
+ - No "works on my machine" issues
2328
+ - Fast setup and deployment
2329
+ - Integrated development tools
2330
+ - Built-in monitoring capabilities
2331
+
2332
+ **For Organizations**:
2333
+ - Reproducible testing environments
2334
+ - CI/CD pipeline integration
2335
+ - Scalable agent deployment
2336
+ - Cost-effective macOS access
2337
+ - Clean resource management
2338
+
2339
+ ### Future Direction
2340
+
2341
+ While the current configuration is optimized for compatibility and stability, the container is designed to be customizable. As hardware capabilities evolve and use cases expand, configurations can be adjusted to leverage more powerful systems while maintaining the core benefits of containerization.
2342
+
2343
+ ### Acknowledgments
2344
+
2345
+ This project builds on the containerization ecosystem and the work of many in the Docker and virtualization communities. Special recognition to:
2346
+ - The Docker team for container technology
2347
+ - The KVM project for virtualization
2348
+ - The open-source community for tools and libraries
2349
+
2350
+ ### Get Involved
2351
+
2352
+ **Feedback & Contact**:
2353
+ - **X (Twitter)**: [@nullvoider07](https://x.com/nullvoider07)
2354
+ - Report issues with detailed information
2355
+ - Share your use cases and experiences
2356
+ - Suggest improvements and features
2357
+
2358
+ **Contributing**:
2359
+ While the core implementation details are open-source, feedback on:
2360
+ - Performance optimization suggestions
2361
+ - Use case requirements
2362
+ - Bug reports and fixes
2363
+ - Documentation improvements
2364
+
2365
+ ...is always welcome and appreciated.
2366
+
2367
+ ---
2368
+
2369
+ **Last Updated:** May, 2026
2370
+ **Version:** 1
2371
+ **Developer:** Kartik (NullVoider)
2372
+ **License:** GPL-3.0
2373
+
2374
+ ---
2375
+
2376
+ **macOS 15.7.5** - Full macOS in one self-contained container. No compromises, no external files, no BS. Powerful. Just works. πŸš€