macOS Installation Guide for Synkra AIOX
Prerequisites
1. Node.js (v20 or higher)
Install Node.js using one of these methods:
Option A: Using Homebrew (Recommended)
# Install Homebrew if not already installed
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
# Install Node.js
brew install node
Option B: Using the official installer Download from nodejs.org
Option C: Using Node Version Manager (nvm)
# Install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
# Install Node.js
nvm install 20
nvm use 20
2. GitHub CLI
Install GitHub CLI for team collaboration:
Using Homebrew (Recommended)
brew install gh
Using MacPorts
sudo port install gh
Using the official installer Download from cli.github.com
Installation
Quick Install
-
Open Terminal
-
Navigate to your project directory:
cd ~/path/to/your/project -
Run the installer:
npx github:SynkraAI/aiox-core install
What the Installer Does
The installer automatically:
- ✅ Detects macOS and applies platform-specific configurations
- ✅ Creates necessary directories with proper permissions
- ✅ Configures IDE paths for macOS locations:
- Cursor:
~/Library/Application Support/Cursor/ - Claude:
~/.claude/
- Cursor:
- ✅ Sets up shell scripts with Unix line endings
- ✅ Handles case-sensitive filesystems properly
IDE-Specific Setup
Cursor
- IDE rules are installed to
.cursor/rules/ - Keyboard shortcut:
Cmd+Lto open chat - Use
@agent-nameto activate agents
Claude Code
-
Commands are installed to
.claude/commands/AIOX/ -
Use
/agent-nameto activate agents -
Use
@agent-nameto activate agents
Troubleshooting
Permission Issues
If you encounter permission errors:
# Fix npm permissions
sudo chown -R $(whoami) ~/.npm
# Fix project permissions
sudo chown -R $(whoami) .aiox-core
GitHub CLI Authentication
After installing GitHub CLI:
# Authenticate with GitHub
gh auth login
# Choose authentication method (web browser recommended)
Path Issues
If commands are not found:
# Add to ~/.zshrc or ~/.bash_profile
export PATH="/usr/local/bin:$PATH"
# Reload shell configuration
source ~/.zshrc # or source ~/.bash_profile
Case Sensitivity
macOS filesystems can be case-insensitive by default. If you experience issues:
-
Check your filesystem:
diskutil info / | grep "File System" -
Synkra AIOX handles both case-sensitive and case-insensitive filesystems automatically
Updating
To update an existing installation:
npx github:SynkraAI/aiox-core install
The updater will:
- Detect your existing installation
- Back up any customizations
- Update only changed files
- Preserve your configurations
Next Steps
- Configure your IDE (see IDE-specific setup above)
- Run
*helpin your AI agent to see available commands - Start with the User Guide
- Join our Discord Community for help
System Requirements
- macOS 10.15 (Catalina) or later
- 4GB RAM minimum (8GB recommended)
- 500MB free disk space
- Internet connection for npm packages