Get Migratrix running fast

Install the Agent

The Agent authenticates using a workspace Agent token. You can provide it via command line or the MIGRATRIX_API_KEY environment variable.

Docker

docker run -d \
  --name migratrix-agent \
  --restart unless-stopped \
  -e MIGRATRIX_API_KEY="<your_agent_api_key_or_jwt>" \
  -e MIGRATRIX_DIR=/data/migratrix \
  -p 4002:4002 \
  -v migratrix-agent-data:/data/migratrix \
  ghcr.io/code-fighter-labs/migratrix-agent:latest

macOS

brew tap code-fighter-labs/tap
brew install migratrix-agent
migratrix-agent --apiKey "<your_agent_api_key_or_jwt>"

Linux

curl -sSL https://github.com/code-fighter-labs/homebrew-tap/releases/latest/download/install.sh | sh
migratrix-agent --apiKey "<your_agent_api_key_or_jwt>"

Windows

iwr https://github.com/code-fighter-labs/homebrew-tap/releases/latest/download/install.ps1 | iex
migratrix-agent --apiKey "<your_agent_api_key_or_jwt>"

Networking and HTTPS

Migratrix separates how the Agent listens from how clients reach it:

• BindAddress: where the Agent listens on the host, such as http://0.0.0.0:4002.
• PublicUrl: the externally reachable address used by the browser and web app, such as https://agent.company.com.

If the Migratrix web app is loaded over HTTPS, browsers will block connections to an HTTP agent. For production, set PublicUrl to an HTTPS address.

For localhost development, mkcert can be used to generate browser-trusted certificates for https://localhost:4002.

Connect Databases and Environments

1. Create or join a workspace.
2. Install an Agent in the network closest to the databases you want to manage.
3. Add connections for each environment such as DEV, QA, and PROD.
4. Assign environment-specific roles for admins, approvers, developers, and viewers.
5. Create one or more migration flows that reflect your promotion path.

Credentials remain on the Agent machine and are not stored on the Migratrix platform.

GitOps Workflow

Migratrix fits into a SQL-in-Git workflow while keeping execution and approvals close to the database delivery process.

1. Write a migration in Migratrix or sync one from GitHub or GitLab.
2. Review schema diff, impact analysis, and generated rollback details.
3. Open or update the pull request tied to the migration.
4. Merge the change and let the configured flow promote it through environments with approvals.
5. Track every step in the audit log and use rollback if recovery is needed.

MCP for AI Tools

Migratrix exposes a remote Model Context Protocol endpoint so approved assistants can inspect database delivery context and help with operational workflows.

Quick setup

Run the setup command locally. It opens Migratrix sign-in, detects supported AI tools, and writes the matching MCP configuration.

npx migratrix-setup

The installer supports Claude Desktop, Cursor, Codex, Windsurf, and Continue. Restart the configured tool after setup so it loads the Migratrix connector.

Manual connector settings

If your MCP client supports remote HTTP servers, configure the Migratrix endpoint and send the user's access token as a bearer token.

URL: https://mcp.migratrix.com/mcp
Authorization: Bearer <access-token>

Mutating tools require a confirm: true argument. This protects approvals, rejections, and execution from accidental assistant actions.

Available MCP tools

• list_workspaces
• list_environments
• get_migrations and get_migration
• get_migration_progress
• analyze_migration_risk
• approve_migration, reject_migration, and execute_migration

Explorer

Explorer lets teams browse tables, preview rows, inspect schema objects, and run SQL with safeguards aligned to each environment.

• Read-only defaults in production.
• Environment-aware RBAC.
• Audited reads and writes.
• AI-assisted query generation from natural language prompts.

Migration Flows

Flows model the path from lower environments to production. Each stage can enforce its own approval policy, execution rules, and rollback behavior.

• Single-step or multi-stage flows.
• Approval gates for QA and production.
• Generated rollback scripts.
• Execution history, live logs, and audit metadata.

Compare and Sync

Compare and Sync is designed for schema drift detection and controlled alignment between environments.

• Schema diff across supported engines.
• Object-level visibility for tables, indexes, constraints, views, and more.
• Generated sync scripts to align target to source.
• Optional data comparison to inspect inserted, updated, and deleted rows.

Migration Studio

Migration Studio is the guided workflow for moving from a selected source to a reviewed target model and validated execution.

1. Select source and target environments, connections, databases, schemas, and model kinds.
2. Run source analysis to discover entities, relationships, row counts, and a canonical model.
3. Generate a draft target model and review the target model, field overrides, ER diagram, and schema preview.
4. Choose one-time full load or Change Data Capture for lower cutover gaps.
5. Run the migration with live progress, written and rejected record counts, run history, and validation output.

Use Migration Studio when the task needs modeling, target-shape decisions, schema generation, CDC options, and post-run validation rather than a simple copy job.

Approvals, Audit, and Safety

• Every migration carries a traceable execution record.
• Approval decisions are tied to users, timestamps, and environments.
• Risk analysis flags destructive or suspicious SQL patterns before execution.
• Rollback readiness helps teams recover faster from bad deployments.

Need Help?

If you need help with onboarding, network topology, or enterprise rollout planning, use the contact form or email sales@migratrix.com.