Skip to content

uninstallation.md

Latest commit

 

History

History
550 lines (397 loc) · 10.3 KB

uninstallation.md

File metadata and controls

550 lines (397 loc) · 10.3 KB
Raw

Uninstallation Guide

🌐 EN | PT | ES

This guide provides comprehensive instructions for uninstalling Synkra AIOX from your system.

Table of Contents

  1. Before You Uninstall
  2. Quick Uninstall
  3. Complete Uninstall
  4. Selective Uninstall
  5. Data Preservation
  6. Clean System Removal
  7. Troubleshooting Uninstall
  8. Post-Uninstall Cleanup
  9. Reinstallation

Before You Uninstall

Important Considerations

⚠️ Warning: Uninstalling Synkra AIOX will:

  • Remove all framework files
  • Delete agent configurations (unless preserved)
  • Clear memory layer data (unless backed up)
  • Remove all custom workflows
  • Delete logs and temporary files

Pre-Uninstall Checklist

  • Backup important data
  • Export custom agents and workflows
  • Save API keys and configurations
  • Document custom modifications
  • Stop all running processes
  • Inform team members

Backup Your Data

# Create complete backup
npx aiox-core backup --complete

# Or manually backup important directories
tar -czf aiox-backup-$(date +%Y%m%d).tar.gz \
  .aiox/ \
  agents/ \
  workflows/ \
  tasks/ \
  --exclude=.aiox/logs \
  --exclude=.aiox/cache

Quick Uninstall

Using Built-in Uninstaller

The fastest way to uninstall Synkra AIOX:

# Basic uninstall (preserves user data)
npx aiox-core uninstall

# Complete uninstall (removes everything)
npx aiox-core uninstall --complete

# Uninstall with data preservation
npx aiox-core uninstall --keep-data

Interactive Uninstall

For guided uninstallation:

npx aiox-core uninstall --interactive

This will prompt you for:

  • What to keep/remove
  • Backup options
  • Confirmation for each step

Complete Uninstall

Step 1: Stop All Services

# Stop all running agents
*deactivate --all

# Stop all workflows
*stop-workflow --all

# Shutdown meta-agent
*shutdown

Step 2: Export Important Data

# Export configurations
*export config --destination backup/config.json

# Export agents
*export agents --destination backup/agents/

# Export workflows
*export workflows --destination backup/workflows/

# Export memory data
*export memory --destination backup/memory.zip

Step 3: Run Uninstaller

# Complete removal
npx aiox-core uninstall --complete --no-backup

Step 4: Remove Global Installation

# Remove global npm package
npm uninstall -g aiox-core

# Remove npx cache
npm cache clean --force

Step 5: Clean System Files

Windows

# Remove AppData files
Remove-Item -Recurse -Force "$env:APPDATA\aiox-core"

# Remove temp files
Remove-Item -Recurse -Force "$env:TEMP\aiox-*"

# Remove registry entries (if any)
Remove-Item -Path "HKCU:\Software\Synkra AIOX" -Recurse

macOS/Linux

# Remove config files
rm -rf ~/.aiox
rm -rf ~/.config/aiox-core

# Remove cache
rm -rf ~/.cache/aiox-core

# Remove temp files
rm -rf /tmp/aiox-*

Selective Uninstall

Remove Specific Components

# Remove only agents
npx aiox-core uninstall agents

# Remove only workflows
npx aiox-core uninstall workflows

# Remove memory layer
npx aiox-core uninstall memory-layer

# Remove specific agent
*uninstall agent-name

Keep Core, Remove Extensions

# Remove all plugins
*plugin remove --all

# Remove Squads
rm -rf Squads/

# Remove custom templates
rm -rf templates/custom/

Data Preservation

What to Keep

Before uninstalling, identify what you want to preserve:

  1. Custom Agents

    # Copy custom agents
cp -r agents/custom/ ~/aiox-backup/agents/

  2. Workflows and Tasks

    # Copy workflows
cp -r workflows/ ~/aiox-backup/workflows/
cp -r tasks/ ~/aiox-backup/tasks/

  3. Memory Data

    # Export memory database
*memory export --format sqlite \
  --destination ~/aiox-backup/memory.db

  4. Configurations

    # Copy all config files
cp .aiox/config.json ~/aiox-backup/
cp .env ~/aiox-backup/

  5. Custom Code

    # Find and backup custom files
find . -name "*.custom.*" -exec cp {} ~/aiox-backup/custom/ \;

Preservation Script

Create preserve-data.sh:

#!/bin/bash
BACKUP_DIR="$HOME/aiox-backup-$(date +%Y%m%d-%H%M%S)"

echo "Creating backup directory: $BACKUP_DIR"
mkdir -p "$BACKUP_DIR"

# Backup function
backup_if_exists() {
    if [ -e "$1" ]; then
        echo "Backing up $1..."
        cp -r "$1" "$BACKUP_DIR/"
    fi
}

# Backup all important data
backup_if_exists ".aiox"
backup_if_exists "agents"
backup_if_exists "workflows"
backup_if_exists "tasks"
backup_if_exists "templates"
backup_if_exists ".env"
backup_if_exists "package.json"

echo "Backup completed at: $BACKUP_DIR"

Clean System Removal

Complete Cleanup Script

Create clean-uninstall.sh:

#!/bin/bash
echo "Synkra AIOX Complete Uninstall"
echo "================================="

# Confirmation
read -p "This will remove ALL Synkra AIOX data. Continue? (y/N) " -n 1 -r
echo
if [[ ! $REPLY =~ ^[Yy]$ ]]; then
    exit 1
fi

# Stop all processes
echo "Stopping all processes..."
pkill -f "aiox-core" || true
pkill -f "aiox-developer" || true

# Remove project files
echo "Removing project files..."
rm -rf .aiox/
rm -rf agents/
rm -rf workflows/
rm -rf tasks/
rm -rf templates/
rm -rf Squads/
rm -rf node_modules/aiox-core/

# Remove global files
echo "Removing global files..."
npm uninstall -g aiox-core

# Remove user data
echo "Removing user data..."
rm -rf ~/.aiox
rm -rf ~/.config/aiox-core
rm -rf ~/.cache/aiox-core

# Clean npm cache
echo "Cleaning npm cache..."
npm cache clean --force

# Remove from package.json
echo "Updating package.json..."
npm uninstall aiox-core/core
npm uninstall aiox-core/memory
npm uninstall aiox-core/meta-agent

echo "Uninstall complete!"

Registry Cleanup (Windows)

# PowerShell script for Windows cleanup
Write-Host "Cleaning Synkra AIOX from Windows Registry..."

# Remove from PATH
$path = [Environment]::GetEnvironmentVariable("PATH", "User")
$newPath = ($path.Split(';') | Where-Object { $_ -notmatch 'aiox-core' }) -join ';'
[Environment]::SetEnvironmentVariable("PATH", $newPath, "User")

# Remove registry keys
Remove-ItemProperty -Path "HKCU:\Environment" -Name "AIOX_*" -ErrorAction SilentlyContinue

# Remove file associations
Remove-Item -Path "HKCU:\Software\Classes\.aiox" -Recurse -ErrorAction SilentlyContinue

Write-Host "Registry cleanup complete!"

Troubleshooting Uninstall

Common Issues

1. Permission Denied

# Linux/macOS
sudo npx aiox-core uninstall --complete

# Windows (Run as Administrator)
npx aiox-core uninstall --complete

2. Process Still Running

# Force stop all processes
# Linux/macOS
killall -9 node
killall -9 aiox-core

# Windows
taskkill /F /IM node.exe
taskkill /F /IM aiox-core.exe

3. Files Locked

# Find processes using files
# Linux/macOS
lsof | grep aiox

# Windows (PowerShell)
Get-Process | Where-Object {$_.Path -like "*aiox*"}

4. Incomplete Removal

# Manual cleanup
find . -name "*aiox*" -type d -exec rm -rf {} +
find . -name "*.aiox*" -type f -delete

Force Uninstall

If normal uninstall fails:

#!/bin/bash
# force-uninstall.sh
echo "Force uninstalling Synkra AIOX..."

# Kill all related processes
pkill -9 -f aiox || true

# Remove all files
rm -rf .aiox* aiox* *aiox*
rm -rf agents workflows tasks templates
rm -rf node_modules/aiox-core
rm -rf ~/.aiox* ~/.config/aiox* ~/.cache/aiox*

# Clean npm
npm cache clean --force
npm uninstall -g aiox-core

echo "Force uninstall complete!"

Post-Uninstall Cleanup

1. Verify Removal

# Check for remaining files
find . -name "*aiox*" 2>/dev/null
find ~ -name "*aiox*" 2>/dev/null

# Check npm packages
npm list -g | grep aiox
npm list | grep aiox

# Check running processes
ps aux | grep aiox

2. Clean Environment Variables

# Remove from .bashrc/.zshrc
sed -i '/AIOX_/d' ~/.bashrc
sed -i '/aiox-core/d' ~/.bashrc

# Remove from .env files
find . -name ".env*" -exec sed -i '/AIOX_/d' {} \;

3. Update Project Files

// Remove from package.json scripts
{
  "scripts": {
    // Remove these entries
    "aiox": "aiox-core",
    "meta-agent": "aiox-core meta-agent"
  }
}

4. Clean Git Repository

# Remove AIOX-specific git hooks
rm -f .git/hooks/*aiox*

# Update .gitignore
sed -i '/.aiox/d' .gitignore
sed -i '/aiox-/d' .gitignore

# Commit removal
git add -A
git commit -m "Remove Synkra AIOX"

Reinstallation

After Complete Uninstall

If you want to reinstall Synkra AIOX:

  1. Wait for cleanup

    # Ensure all processes stopped
sleep 5

  2. Clear npm cache

    npm cache clean --force

  3. Fresh installation

    npx aiox-core@latest init my-project

Restoring from Backup

# Restore saved data
cd my-project

# Restore configurations
cp ~/aiox-backup/config.json .aiox/

# Restore agents
cp -r ~/aiox-backup/agents/* ./agents/

# Import memory
*memory import ~/aiox-backup/memory.zip

# Verify restoration
*doctor --verify-restore

Uninstall Verification Checklist

  • All AIOX processes stopped
  • Project files removed
  • Global npm package uninstalled
  • User configuration files deleted
  • Cache directories cleaned
  • Environment variables removed
  • Registry entries cleaned (Windows)
  • Git repository updated
  • No remaining AIOX files found
  • System PATH updated

Getting Help

If you encounter issues during uninstallation:

  1. Check Documentation

  2. Community Support

    • Discord: #uninstall-help
    • GitHub Issues: Label with "uninstall"

  3. Emergency Support

    # Generate uninstall report
npx aiox-core diagnose --uninstall > uninstall-report.log

Remember: Always backup your data before uninstalling. The uninstall process is irreversible, and data recovery may not be possible without proper backups.