/init-ad-migration

Initialize ad-migration plugin

Bootstrap the project and validate local prerequisites before running the ad-migration setup commands.

Progress Tracking

Use TaskCreate and TaskUpdate to track the automated phases of this command. After the user confirms (Step 4) and before execution begins, create tasks for each automated step that will run (e.g. Install dependencies, Scaffold project files, Commit scaffolding — only include steps that are actually needed). Update each task to in_progress when it starts and to completed or cancelled (include the error reason) when it finishes. Do not create tasks for interactive steps (source selection, confirmation prompts).

Step 1: Pre-check

If CLAUDE_PLUGIN_ROOT is not set, stop immediately and tell the user to load the plugin with claude --plugin-dir <path-to-ad-migration> before running this command.

Classify the host before any prerequisite checks:

Host	Action
macOS	supported; use Homebrew remediation where documented
Linux	supported; use platform package manager guidance
WSL	supported; treat as Linux
Native Windows	unsupported; stop and say "Use WSL for the local workflow."

Step 1.5: Install ad-migration CLI

Check whether ad-migration is already on PATH:

ad-migration --version 2>/dev/null && echo "INSTALLED" || echo "NOT_FOUND"

If already installed, print the version and continue to Step 2.

If not installed:

Host	Action
macOS	install via Homebrew
Linux or WSL	stop and tell the user to install the GitHub release wheel artifacts into Python 3.11+, then re-run /init-ad-migration

Do not attempt brew install on Linux or WSL.

For macOS, install via Homebrew; this path is supported only on macOS:

brew tap accelerate-data/homebrew-tap
brew install ad-migration

After installing, verify:

ad-migration --version
ad-migration doctor drivers --project-root . --json

If ad-migration doctor drivers fails here, apply the public CLI runtime doctor failure policy below.

If Homebrew is not available on the user's macOS machine, tell them:

Install Homebrew first: /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" Then re-run /init-ad-migration.

Do not continue if ad-migration --version or ad-migration doctor drivers still fails after installation.

Public CLI runtime doctor failure policy

ad-migration doctor drivers checks the public CLI runtime that will later execute setup commands, including backend Python drivers and dbt adapter modules. If it fails, stop before handing the user to ad-migration setup-target or ad-migration setup-sandbox. Failure guidance must say: "Fix the public CLI package or Homebrew formula resources so this module is bundled with the installed ad-migration runtime." Do not tell the user to run pip install, uv pip install, or otherwise mutate the brewed virtualenv.

Step 2: Runtime selection

Determine which source and target technologies to configure:

1. Check $ARGUMENTS for a positional source slug (e.g. /init-ad-migration oracle or /init-ad-migration sql_server).
2. If no source argument was provided, ask the user to choose:

Which source database are you migrating from?

1. sql_server — Microsoft SQL Server (T-SQL)
2. oracle — Oracle Database (PL/SQL)

If an existing manifest.json already suggests a source technology, present that as the default in this source-only question. Do not combine the target question with it.

Resolve the source selection first. Only after source is resolved, ask the user which target technology they want to generate dbt assets for:

Which target database technology are you writing dbt assets for?

1. sql_server — Microsoft SQL Server
2. oracle — Oracle Database

Validate both chosen slugs against the source registry in init.py. If either slug is unknown, list the valid options and ask again.

Store the chosen slugs as $SOURCE and $TARGET for the remaining steps. Ask these questions one at a time; never present source and target selection in the same prompt.

Do not prompt for sandbox separately. Initialize runtime.sandbox from $SOURCE.

Step 3: Gather evidence

Read existing handoff state

Before running any checks, read manifest.json in the project root. If it contains an init_handoff key, load it as $EXISTING_HANDOFF. For idempotency, skip checks already recorded as passing in the matching handoff section. Re-run checks that are false, missing, or belong to a different selected technology.

To force a full re-check of all prerequisites, the user must delete manifest.json manually.

Run only the needed checks silently

Do NOT install or change anything yet — only gather evidence for items not already validated.

Common prerequisites (all projects)

1. uv --version — is uv installed?
2. python3 --version — is Python >= 3.11?
3. uv run --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal" python3 -c "import pydantic, sqlglot, typer" — are shared package deps synced?
4. uv run "${CLAUDE_PLUGIN_ROOT}/mcp/ddl/server.py" --help — does the DDL MCP server start cleanly?
5. git rev-parse --is-inside-work-tree — is the current working directory inside a git repository? If not, warn the user that the project folder is not under version control and recommend initialising git before running extraction skills.
6. direnv version — is direnv installed? This is optional; mark as — if missing.
7. ad-migration doctor drivers --project-root . --json — are all supported backend Python drivers and dbt adapters importable from the public CLI runtime?

Run the public CLI runtime doctor after source/target runtime selection, even if it already passed immediately after Homebrew installation. If it fails, apply the public CLI runtime doctor failure policy.

Source runtime prerequisites

Run the source-stack checks for $SOURCE. These checks validate only local machine readiness for the selected source technology.

When $SOURCE is sql_server

1. uv run --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal" init check-freetds — verify that FreeTDS is installed, odbcinst is available, and FreeTDS appears in odbcinst -q -d. On macOS, FreeTDS may come from Homebrew. On Linux and WSL, FreeTDS and unixODBC may come from the platform package manager.
2. uv run --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal" init discover-mssql-driver-override — discover the effective local SQL Server driver override. If the result is status="resolved", add MSSQL_DRIVER to $OVERRIDES. If the result is status="manual", show the returned message verbatim.

When $SOURCE is oracle

No additional source runtime prerequisites beyond common checks. Oracle extraction uses the oracledb Python client (synced in Step 5).

Target runtime prerequisites

Run the target-stack checks for $TARGET. These checks validate only local machine readiness for the selected target technology.

When $TARGET is sql_server

1. uv run --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal" python3 -c "import pyodbc" — is the SQL Server Python client available?
2. uv run --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal" init discover-mssql-driver-override — discover the effective local SQL Server driver override. If the result is status="resolved" and MSSQL_DRIVER is not already present in $OVERRIDES, add it. If the result is status="manual", show the returned message verbatim.

When $TARGET is oracle

1. uv run --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal" python3 -c "import oracledb" — is the Oracle Python client available?

Step 4: Present plan

Show the user what was found and what needs to be done, grouped into common, source-runtime, and target-runtime sections:

Common prerequisites:
  uv:          ✓ installed (x.y.z)  /  ✗ not found
  python:      ✓ 3.x.x              /  ✗ not found or < 3.11
  shared deps: ✓ synced             /  ✗ not synced
  ddl_mcp:     ✓ starts             /  ✗ fails
  git:         ✓ repo detected      /  — not a git repo (recommended)
  direnv:      ✓ installed (x.y.z)  /  — not found (recommended)
  public drivers: ✓ importable      /  ✗ missing from public CLI runtime

For source = SQL Server:

Source runtime (SQL Server):
  freetds:                ✓ installed + registered  /  ✗ not installed  /  ✗ unixODBC missing  /  ✗ not registered
  mssql_driver_override:  ✓ resolved  /  — default FreeTDS  /  ✗ manual override needed

For target = SQL Server:

Target runtime (SQL Server):
  pyodbc:                 ✓ importable  /  ✗ missing
  mssql_driver_override:  ✓ resolved  /  — default FreeTDS  /  ✗ manual override needed

For target = Oracle:

Target runtime (Oracle):
  oracledb:  ✓ importable  /  ✗ missing

direnv is marked — (not ✗) when missing — it is recommended but optional.

For SQL Server, freetds is only green after both installation and unixODBC registration pass. If FreeTDS is installed but odbcinst is missing, treat that as a failed prerequisite because ad-migration setup-source will not work with the default MSSQL_DRIVER="FreeTDS" path.

If any local override is discovered or required, explain that init writes only non-secret machine-specific overrides into .env, while .envrc remains the shared repo-local scaffold:

Recommended: keep machine-local overrides in .env. The scaffolding step writes repo-shared environment scaffolding to .envrc and loads .env when present. Use .env only for non-secret local overrides such as MSSQL_DRIVER. Connection details are collected later in the stage-specific setup commands.

If everything is already validated (all items true in the existing handoff and no new gaps found), say "All prerequisites validated" and proceed directly to Step 6 without asking for confirmation. Otherwise, ask the user to confirm before proceeding with Step 5.

Step 5: Execute

Only after the user confirms, run the needed actions:

Install uv (if missing):

curl -LsSf https://astral.sh/uv/install.sh | sh

After installing, re-run uv --version to confirm. Tell the user to restart their shell if the command is not found after install.

Python missing: cannot auto-install. Tell the user to install Python 3.11+ from https://python.org/downloads and re-run /init-ad-migration after installing. Stop here for this check — do not proceed to shared deps without Python.

Sync shared deps (if not synced):

uv sync --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal"

Install FreeTDS (SQL Server, if missing):

On macOS:

brew install freetds

On Linux or WSL, tell the user to install FreeTDS and unixODBC using the platform package manager, then re-run /init-ad-migration. For example, Debian/Ubuntu users typically install freetds-dev, freetds-bin, and unixodbc.

After installing, re-run init check-freetds to confirm. FreeTDS is the default ODBC driver for SQL Server connectivity. Users who prefer the Microsoft driver can set MSSQL_DRIVER="ODBC Driver 18 for SQL Server" and install msodbcsql18 themselves (requires interactive EULA acceptance).

Register FreeTDS in unixODBC (SQL Server, when installed but not registered):

uv run --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal" init check-freetds --register-missing

This command must succeed and report registered: true before you record freetds: true in the handoff.

Sync source-specific deps:

For SQL Server:

uv sync --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal" --extra export

For Oracle:

uv sync --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal" --extra oracle

Verify target client libraries:

For SQL Server target:

uv run --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal" python3 -c "import pyodbc"

For Oracle target:

uv run --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal" python3 -c "import oracledb"

These internal/plugin uv checks must remain in place; they validate agent and internal command readiness. They do not replace the public CLI runtime driver doctor.

Verify public CLI backend drivers and dbt adapters:

ad-migration doctor drivers --project-root . --json

This command validates the installed public ad-migration runtime. If it fails, apply the public CLI runtime doctor failure policy.

ddl_mcp fails (after shared sync): re-run the ddl_mcp check. If it still fails, show the error output to the user and tell them to check their Python environment.

direnv missing (if the user asks how to install it): Direct them to https://direnv.net for install instructions. Do not attempt to install it automatically.

Step 6: Scaffold project files

Run the init CLI to scaffold the project directory, passing the chosen source technology. This creates CLAUDE.md, README.md, repo-map.json, .gitignore, .envrc, .claude/rules/git-workflow.md, and .githooks/pre-commit — all idempotently and parameterized by source.

uv run --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal" init scaffold-project --project-root . --technology $SOURCE
uv run --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal" init scaffold-hooks --project-root . --technology $SOURCE

Parse the JSON output and report to the user which files were created, updated, or skipped.

If scaffold-project reports missing CLAUDE.md sections (in files_skipped), tell the user which sections are missing and recommend adding them.

Maintain a JSON object $OVERRIDES while gathering evidence. Add only non-secret machine-specific resolved overrides such as MSSQL_DRIVER.

If $OVERRIDES is non-empty, write it to .env in the project root:

Use the deterministic init helper for that write:

uv run --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal" init write-local-env-overrides --project-root . --overrides-json '$OVERRIDES'

Then write the partial manifest with prerequisite validation results. Build a JSON object $PREREQS from the combined results of Steps 3-5 (merging any existing handoff values with newly validated items). The object should record common startup checks plus role-scoped startup readiness:

{
  "common": {
    "startup": {"uv": true, "python": true, "shared_deps": true, "ddl_mcp": true, "direnv": false}
  },
  "roles": {
    "source": {"technology": "sql_server", "startup": {"freetds": true, "driver_override_resolved": true}},
    "sandbox": {"technology": "sql_server", "startup": {"freetds": true, "driver_override_resolved": true}},
    "target": {"technology": "oracle", "startup": {"oracledb": true}}
  }
}

Pass it to the CLI:

uv run --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal" setup-ddl write-partial-manifest --project-root . --technology $SOURCE --target-technology $TARGET --prereqs-json '$PREREQS'

Re-running /init-ad-migration reads the handoff from manifest.json and skips already-passing checks.

Step 7: Commit

If the working directory is a git repository, check the current branch first:

git branch --show-current

If on main, notify the user:

⚠️ Committing init files directly to main. Init scaffolding is typically committed to main — this is expected. For migration work that follows, create a feature branch before running /scope-tables, /profile-tables, or other pipeline commands.

Commit the files created or modified in Step 5:

git add CLAUDE.md README.md .gitignore .githooks/ repo-map.json .claude/ scripts/ manifest.json
git commit -m "chore: init migration project ($SOURCE)"

Do not stage .env. It contains machine-local secrets. .envrc is tracked scaffolded config and must stay secret-free.

If not a git repository, skip silently.

Then tell the user: "Restart Claude to pick up the new project instructions."

Step 8: Handoff

Tell the user:

For source = SQL Server:

• SOURCE_MSSQL_ vars set*: ready to extract DDL from the live database:

  !ad-migration setup-source --schemas <schema>
  

• SOURCE_MSSQL_ vars unset*: Set SOURCE_MSSQL_HOST/PORT/DB/USER in .envrc, set SOURCE_MSSQL_PASSWORD in .env, run direnv allow, then run:

  !ad-migration setup-source --schemas <schema>
  

For source = Oracle:

• SOURCE_ORACLE_ vars set*: ready to extract DDL from the live database:

  !ad-migration setup-source --schemas <schema>
  

• SOURCE_ORACLE_ vars unset*: Set SOURCE_ORACLE_HOST/PORT/SERVICE/USER in .envrc, set SOURCE_ORACLE_PASSWORD in .env, run direnv allow, then run:

  !ad-migration setup-source --schemas <schema>
  

For target setup:

• TARGET_ vars set*: ready to run ad-migration setup-target.
• TARGET_ vars unset*: Set the required target vars in .envrc, set the password var in .env, run direnv allow, then run ad-migration setup-target.

For sandbox setup:

• SANDBOX_ vars set*: ready to run ad-migration setup-sandbox.
• SANDBOX_ vars unset*: Set the required sandbox vars in .envrc, set the password var in .env, run direnv allow, then run ad-migration setup-sandbox.

Error handling

Command	Exit code	Action
init scaffold-project	non-zero	File IO failure. Surface error message, stop
init scaffold-project	0 + files_skipped non-empty	Files already exist. Report which were skipped — not an error
init scaffold-hooks	non-zero	Hook creation or git config failed. Surface error message
setup-ddl write-partial-manifest	non-zero	Technology validation or IO failure. Surface error message, stop
uv run ... python3 -c "import ..."	non-zero	Shared deps not synced. Tell user to run uv sync --project "${CLAUDE_PLUGIN_ROOT}/packages/ad-migration-internal"

Idempotency

Safe to re-run. Each step checks current state before acting:

• Runtime selection re-evaluates $ARGUMENTS each time for the source role and re-prompts for target when needed.
• Step 3 reads existing init_handoff from manifest.json and skips checks already recorded as passing for the same selected technology. Only items marked false, missing, or tied to a different selected technology are re-checked.
• Step 5 uses the init CLI which is fully idempotent: existing CLAUDE.md is checked for missing sections (not overwritten), README.md and repo-map.json are skipped if present, .gitignore gets only missing entries appended, .envrc is skipped if present, .claude/rules/git-workflow.md is skipped if present, .githooks/pre-commit is skipped if present.
• Step 6 partial manifest updates runtime.source, runtime.sandbox, and runtime.target, merges existing handoff passes with newly validated items, and updates the timestamp.
• Step 7 only commits if there are staged changes.