Quick Start

Complete CueMate installation and deployment in 5 minutes.

1. System Requirements

• macOS 13.0+ or Windows 10/11 (64-bit)
• 4GB+ RAM
• 10GB+ disk space

2. Download Installation Package

2.1 macOS

CueMate offers two types of installation packages:

• Online Package (~670MB): Faster download, requires network to pull Docker images during installation
• Offline Package (~4.4GB): Larger size, ready to use without network

Choose the installation package based on your chip type:

Chip Type	Online Package	Offline Package
Apple Silicon (M1/M2/M3)	CueMate-v0.1.1-macos-arm64-online.dmg	CueMate-v0.1.1-macos-arm64-offline.dmg
Intel	CueMate-v0.1.1-macos-x64-online.dmg	CueMate-v0.1.1-macos-x64-offline.dmg

TIP

For first-time installation, the Offline Package is recommended as it includes all dependencies without additional downloads.

Download Links:

• Baidu Netdisk: https://pan.baidu.com/s/15jwZHy8YkDa4cEDLIYRo9Q?pwd=3477 (Extraction Code: 3477)
• GitHub Releases: https://github.com/cuemate-chat/cuemate/releases

2.2 Windows

Under Development

The Windows version is under development and expected to be released in the next major version. The current version only supports macOS.

3. Run Installation

3.1 macOS Installation

1. Double-click the downloaded .dmg file
2. Run the CueMate installation wizard
3. Follow the wizard prompts to complete the 8-step installation process (about 3-5 minutes):
   • 1.Welcome → 2.License Agreement → 3.Install Location → 4.Disk Space Check
   • 5.Docker Check → 6.Port Check → 7.Image Loading → 8.Complete (Launch App)

Notes:

• The installation wizard will automatically detect and install Docker Desktop (if not installed)
• The installation process will automatically load and start all backend services

For detailed installation steps and common issue resolution, please refer to the macOS Installation Guide.

3.2 Windows Installation

Windows version installation steps will be updated upon official release. See Windows Installation Guide.

4. Verify Installation

After installation is complete, the installation wizard will prompt you. Click to launch the CueMate application.

4.1 Check Service Status

Go to the "Docker Monitor" page (Top dropdown menu → Docker Monitor) and confirm all 6 services show as "Running" (green label):

• cuemate-web - Main Window Service
• cuemate-web-api - Backend API Service
• cuemate-llm-router - LLM Router Service
• cuemate-rag-service - Knowledge Base Retrieval Service
• cuemate-asr - Speech Recognition Service
• cuemate-chroma - Vector Database

If any service is abnormal:

1. Click the "Logs" button for the service to view error messages
2. Click the "Restart" button to attempt repair
3. If the issue persists, please refer to the Service Management documentation

5. Installation Complete

CueMate has been successfully installed. Launch it through the installation wizard or click the CueMate icon in Launchpad.

After launching, the login interface will appear:

Built-in Account Information:

• Username: admin
• Password: cuemate

6. Next Steps

• First-time Configuration: Configure AI models, test speech recognition, etc. See individual feature documentation

  • Configure AI Model: See Model Settings documentation
  • System Settings: See System Settings documentation
  • Voice Test: See Voice Test documentation

• Version Upgrade: Update online through the version management feature. See Version Upgrade documentation

• Service Management: View service status, restart services, view logs. See Service Management documentation

• Uninstall Application: Completely uninstall CueMate. See Uninstall Guide documentation

7. FAQ

7.1 Installation Wizard Won't Open

macOS: If prompted "from an unidentified developer"

• Open "System Settings" → "Privacy & Security"
• Find the blocked prompt, click "Open Anyway"

Windows: If blocked by SmartScreen

• Click "More info" → "Run anyway"

7.2 Docker Desktop Not Installed

The installation wizard will automatically detect Docker Desktop:

• If not installed, it will install automatically
• Or download it yourself: https://www.docker.com/products/docker-desktop/
• After installing Docker, return to the installation wizard and click "Re-detect"

7.3 Port Occupied

The installation wizard will detect port conflicts:

• It will display the program name occupying the port
• Click "Auto Resolve" to close the occupying program
• Or manually close the program and click "Re-detect"

7.4 Image Loading Failed

Possible causes:

• Network connection interrupted
• Docker service abnormal
• Insufficient disk space

Solutions:

1. Check network connection and Docker status
2. Confirm sufficient disk space
3. Click "Retry" button to reload

For more installation issues, please refer to the FAQ section in the macOS Installation Guide.

8. Get Help

• Check FAQ
• Visit GitHub Issues
• Email: nuneatonhydroplane@gmail.com