Installation

Install from Source

Sound Suite is installed by cloning the repository and building locally. This is currently the only installation method and works on macOS, Linux, and Windows.

Prerequisites

Install

# Clone the repository
git clone https://github.com/alperu/soundsuite.git
cd soundsuite

# Install dependencies
npm install

# Generate Prisma client
npx prisma generate

# Build for production
npm run build

# Start in development mode
npm run dev

# Or start in production mode
npm run svc:start:prod

After starting, open your browser to:

Service Management

Sound Suite includes cross-platform service management commands:

npm run svc:start       # Start all services (development mode)
npm run svc:start:prod  # Start all services (production mode)
npm run svc:stop        # Stop all services
npm run svc:restart     # Restart all services
npm run svc:health      # Check service health

Verifying Your Installation

After starting, verify everything is working:

npm run svc:health

You should see:

  • Dashboard running on port 3000
  • MCP Server running on port 3001
  • File Watcher active
  • Job Queue ready
  • Database connected

You can also open the dashboard and check the status bar — all services should show green indicators.

Docker (Coming Soon)

Docker deployment is on the roadmap. Once available, it will support docker compose up to run the main application in a container with all dependencies included.

Note that the GPU Sidecar — a separate component for running local AI models — already uses Docker for its model containers. See the Sidecar page for details on that component's Docker usage.

Updating

To update Sound Suite to the latest version:

cd soundsuite

# Pull the latest changes
git pull origin main

# Install any new or changed dependencies
npm install

# Regenerate Prisma client (in case the schema changed)
npx prisma generate

# Rebuild the application
npm run build

After updating, restart the services:

npm run svc:restart

Uninstalling

To remove Sound Suite:

  1. Stop the services: npm run svc:stop
  2. Remove the cloned directory: rm -rf soundsuite

Your case documents are untouched — they live in your case folders, not in the application directory.

If you want to back up application data before removing:

  • Database: prisma/data/sound-suite.db — contains your case metadata and processing history
  • Vector index: data/lancedb/ — contains document embeddings (can be regenerated by re-indexing your documents)