sqlew 3.7.4 → 3.8.0

package/docs/cli/README.md

@@ -1,227 +1,227 @@
-# sqlew CLI Mode
-
-> Command-line tools for database migration and project data export/import
-
-## Overview
-
-sqlew provides CLI commands for advanced database operations that complement the main MCP server functionality. These
-commands are useful for database administration, backup/restore, and cross-project data migration.
-
-## What is CLI Mode?
-
-While the primary use of sqlew is as an **MCP server** (integrated with Claude Code via `.mcp.json`), it also provides
-standalone **CLI commands** for:
-
-- **Database Migration** - Generate SQL dumps for SQLite, MySQL, PostgresSQL migration
-- **Project Export/Import** - Share project data across databases or team members
-- **Backup/Restore** - Create SQL backups with schema and data
-
-## MCP Server vs CLI Mode
-
-| Feature         | MCP Server (`npx sqlew`)               | CLI Mode                                     |
-|-----------------|----------------------------------------|----------------------------------------------|
-| **Primary Use** | AI agent context management            | Database administration                      |
-| **Setup**       | `.mcp.json` configuration              | Per-project npm install                      |
-| **Commands**    | MCP tools (decision, task, file, etc.) | CLI commands (db:dump, db:export, db:import) |
-| **When to Use** | Daily AI development workflow          | Database migration, backup, data sharing     |
-
-## Installation
-
-### Install sqlew in Your Project
-
-```bash
-cd /path/to/your/project
-npm install sqlew
-```
-
-### Add npm Script Shortcut (Recommended)
-
-Add to your `package.json`:
-
-```json
-{
-  "scripts": {
-    "sqlew": "node node_modules/sqlew/dist/cli.js"
-  }
-}
-```
-
-Then you can use shorter commands:
-
-```bash
-npm run sqlew db:dump --format=mysql --output=backup.sql
-```
-
-### Direct Command (Without Shortcut)
-
-```bash
-node node_modules/sqlew/dist/cli.js db:dump --format=mysql --output=backup.sql
-```
-
-## Available Commands
-
-### 1. `db:dump` - SQL Database Migration
-
-Generate complete SQL dumps (schema + data) for database migration or backup.
-
-**Use Cases**:
-
-- Full database backup with schema
-- Cross-database migration (SQLite → MySQL/PostgresSQL)
-- Development → Production deployment
-
-**Quick Example**:
-
-```bash
-# Backup SQLite to MySQL dump
-node node_modules/sqlew/dist/cli.js db:dump --format=mysql --output=backup.sql
-
-# Backup to PostgresSQL dump
-node node_modules/sqlew/dist/cli.js db:dump --format=postgresql --output=backup.sql
-```
-
-**📖 Full Documentation**: [DATABASE_MIGRATION.md](DATABASE_MIGRATION.md)
-
----
-
-### 2. `db:export` - Project Data Export
-
-Export project data to JSON format for sharing or multi-project consolidation.
-
-**Use Cases**:
-
-- Share context with team members
-- Move projects between different databases
-- Consolidate multiple projects into one database
-
-**Quick Example**:
-
-```bash
-# Export specific project
-node node_modules/sqlew/dist/cli.js db:export --project=my-project --output=project.json
-
-# Export all projects
-node node_modules/sqlew/dist/cli.js db:export --output=all-projects.json
-```
-
-**📖 Full Documentation**: [DATA_EXPORT_IMPORT.md](DATA_EXPORT_IMPORT.md#export-command)
-
----
-
-### 3. `db:import` - Project Data Import
-
-Import project data from JSON export files.
-
-**Use Cases**:
-
-- Import shared project context
-- Merge multiple projects into one database
-- Migrate projects to a new database (different machine or DB type)
-
-**Quick Example**:
-
-```bash
-# Import from JSON export
-node node_modules/sqlew/dist/cli.js db:import --source=project.json
-
-# Import with custom name
-node node_modules/sqlew/dist/cli.js db:import --source=project.json --project-name=new-name
-
-# Dry-run validation
-node node_modules/sqlew/dist/cli.js db:import --source=project.json --dry-run
-```
-
-**📖 Full Documentation**: [DATA_EXPORT_IMPORT.md](DATA_EXPORT_IMPORT.md#import-command)
-
----
-
-## Quick Comparison: When to Use Which Command
-
-| Scenario                                      | Use Command               | Restore Capability         |
-|-----------------------------------------------|---------------------------|----------------------------|
-| **Full database backup**                      | `db:dump`                 | ✅ Full restore             |
-| **Cross-database migration** (SQLite → MySQL) | `db:dump`                 | ✅ Full restore             |
-| **Share project with team**                   | `db:export` / `db:import` | ⚠️ Skips if project exists |
-| **Consolidate multiple projects**             | `db:export` / `db:import` | ⚠️ Skips if project exists |
-| **Backup/restore same database**              | `db:dump`                 | ✅ Full restore             |
-
-**⚠️ Important**: `db:export`/`db:import` uses `--skip-if-exists=true` by default, so it's NOT suitable for
-backup/restore to the same database. Use `db:dump` for proper backup/restore.
-
-## Common Workflows
-
-### Workflow 1: Full Database Backup
-
-```bash
-# Create SQL backup with schema + data
-node node_modules/sqlew/dist/cli.js db:dump --format=sqlite --output=backup-$(date +%Y%m%d).sql
-
-# Or simple SQLite file copy
-cp .sqlew/sqlew.db .sqlew/backup-$(date +%Y%m%d).db
-```
-
-### Workflow 2: Share the Project with a Team Member
-
-```bash
-# Developer A: Export project
-node node_modules/sqlew/dist/cli.js db:export --project=feature-x --output=feature-x.json
-
-# Developer B: Import project (in their own database)
-node node_modules/sqlew/dist/cli.js db:import --source=feature-x.json
-```
-
-### Workflow 3: Migrate to MySQL from SQLite
-
-```bash
-# Step 1: Generate MySQL dump
-node node_modules/sqlew/dist/cli.js db:dump --format=mysql --output=migrate-to-mysql.sql
-
-# Step 2: Create MySQL database
-mysql -e "CREATE DATABASE sqlew_db CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
-
-# Step 3: Import dump
-mysql sqlew_db < migrate-to-mysql.sql
-```
-
-### Workflow 4: Consolidate Multiple Projects (Permission-Constrained)
-
-```bash
-# Export from each project
-cd ~/project-a && node node_modules/sqlew/dist/cli.js db:export --project=project-a --output=/tmp/a.json
-cd ~/project-b && node node_modules/sqlew/dist/cli.js db:export --project=project-b --output=/tmp/b.json
-
-# Import all to shared database
-cd ~/shared-db
-node node_modules/sqlew/dist/cli.js db:import --source=/tmp/a.json
-node node_modules/sqlew/dist/cli.js db:import --source=/tmp/b.json
-```
-
-## Getting Help
-
-Show command-specific help:
-
-```bash
-node node_modules/sqlew/dist/cli.js db:dump --help
-node node_modules/sqlew/dist/cli.js db:export --help
-node node_modules/sqlew/dist/cli.js db:import --help
-```
-
-## Detailed Documentation
-
-- **[DATABASE_MIGRATION.md](DATABASE_MIGRATION.md)** - Complete `db:dump` reference
-    - SQL dump generation for all database types
-    - Data type mappings
-    - Transaction safety
-    - Conflict resolution
-
-- **[DATA_EXPORT_IMPORT.md](DATA_EXPORT_IMPORT.md)** - Complete `db:export`/`db:import` reference
-    - JSON export/import system
-    - ID remapping strategy
-    - Multi-project consolidation
-    - Use cases and examples
-
-## See Also
-
-- [Main README](../../README.md) - MCP server setup and usage
-- [Configuration Guide](../CONFIGURATION.md) - Database configuration options
-- [Architecture](../ARCHITECTURE.md) - Technical architecture overview
+# sqlew CLI Mode
+
+> Command-line tools for database migration and project data export/import
+
+## Overview
+
+sqlew provides CLI commands for advanced database operations that complement the main MCP server functionality. These
+commands are useful for database administration, backup/restore, and cross-project data migration.
+
+## What is CLI Mode?
+
+While the primary use of sqlew is as an **MCP server** (integrated with Claude Code via `.mcp.json`), it also provides
+standalone **CLI commands** for:
+
+- **Database Migration** - Generate SQL dumps for SQLite, MySQL, PostgresSQL migration
+- **Project Export/Import** - Share project data across databases or team members
+- **Backup/Restore** - Create SQL backups with schema and data
+
+## MCP Server vs CLI Mode
+
+| Feature         | MCP Server (`npx sqlew`)               | CLI Mode                                     |
+|-----------------|----------------------------------------|----------------------------------------------|
+| **Primary Use** | AI agent context management            | Database administration                      |
+| **Setup**       | `.mcp.json` configuration              | Per-project npm install                      |
+| **Commands**    | MCP tools (decision, task, file, etc.) | CLI commands (db:dump, db:export, db:import) |
+| **When to Use** | Daily AI development workflow          | Database migration, backup, data sharing     |
+
+## Installation
+
+### Install sqlew in Your Project
+
+```bash
+cd /path/to/your/project
+npm install sqlew
+```
+
+### Add npm Script Shortcut (Recommended)
+
+Add to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "sqlew": "node node_modules/sqlew/dist/cli.js"
+  }
+}
+```
+
+Then you can use shorter commands:
+
+```bash
+npm run sqlew db:dump --format=mysql --output=backup.sql
+```
+
+### Direct Command (Without Shortcut)
+
+```bash
+node node_modules/sqlew/dist/cli.js db:dump --format=mysql --output=backup.sql
+```
+
+## Available Commands
+
+### 1. `db:dump` - SQL Database Migration
+
+Generate complete SQL dumps (schema + data) for database migration or backup.
+
+**Use Cases**:
+
+- Full database backup with schema
+- Cross-database migration (SQLite → MySQL/PostgresSQL)
+- Development → Production deployment
+
+**Quick Example**:
+
+```bash
+# Backup SQLite to MySQL dump
+node node_modules/sqlew/dist/cli.js db:dump --format=mysql --output=backup.sql
+
+# Backup to PostgresSQL dump
+node node_modules/sqlew/dist/cli.js db:dump --format=postgresql --output=backup.sql
+```
+
+**📖 Full Documentation**: [DATABASE_MIGRATION.md](DATABASE_MIGRATION.md)
+
+---
+
+### 2. `db:export` - Project Data Export
+
+Export project data to JSON format for sharing or multi-project consolidation.
+
+**Use Cases**:
+
+- Share context with team members
+- Move projects between different databases
+- Consolidate multiple projects into one database
+
+**Quick Example**:
+
+```bash
+# Export specific project
+node node_modules/sqlew/dist/cli.js db:export --project=my-project --output=project.json
+
+# Export all projects
+node node_modules/sqlew/dist/cli.js db:export --output=all-projects.json
+```
+
+**📖 Full Documentation**: [DATA_EXPORT_IMPORT.md](DATA_EXPORT_IMPORT.md#export-command)
+
+---
+
+### 3. `db:import` - Project Data Import
+
+Import project data from JSON export files.
+
+**Use Cases**:
+
+- Import shared project context
+- Merge multiple projects into one database
+- Migrate projects to a new database (different machine or DB type)
+
+**Quick Example**:
+
+```bash
+# Import from JSON export
+node node_modules/sqlew/dist/cli.js db:import --source=project.json
+
+# Import with custom name
+node node_modules/sqlew/dist/cli.js db:import --source=project.json --project-name=new-name
+
+# Dry-run validation
+node node_modules/sqlew/dist/cli.js db:import --source=project.json --dry-run
+```
+
+**📖 Full Documentation**: [DATA_EXPORT_IMPORT.md](DATA_EXPORT_IMPORT.md#import-command)
+
+---
+
+## Quick Comparison: When to Use Which Command
+
+| Scenario                                      | Use Command               | Restore Capability         |
+|-----------------------------------------------|---------------------------|----------------------------|
+| **Full database backup**                      | `db:dump`                 | ✅ Full restore             |
+| **Cross-database migration** (SQLite → MySQL) | `db:dump`                 | ✅ Full restore             |
+| **Share project with team**                   | `db:export` / `db:import` | ⚠️ Skips if project exists |
+| **Consolidate multiple projects**             | `db:export` / `db:import` | ⚠️ Skips if project exists |
+| **Backup/restore same database**              | `db:dump`                 | ✅ Full restore             |
+
+**⚠️ Important**: `db:export`/`db:import` uses `--skip-if-exists=true` by default, so it's NOT suitable for
+backup/restore to the same database. Use `db:dump` for proper backup/restore.
+
+## Common Workflows
+
+### Workflow 1: Full Database Backup
+
+```bash
+# Create SQL backup with schema + data
+node node_modules/sqlew/dist/cli.js db:dump --format=sqlite --output=backup-$(date +%Y%m%d).sql
+
+# Or simple SQLite file copy
+cp .sqlew/sqlew.db .sqlew/backup-$(date +%Y%m%d).db
+```
+
+### Workflow 2: Share the Project with a Team Member
+
+```bash
+# Developer A: Export project
+node node_modules/sqlew/dist/cli.js db:export --project=feature-x --output=feature-x.json
+
+# Developer B: Import project (in their own database)
+node node_modules/sqlew/dist/cli.js db:import --source=feature-x.json
+```
+
+### Workflow 3: Migrate to MySQL from SQLite
+
+```bash
+# Step 1: Generate MySQL dump
+node node_modules/sqlew/dist/cli.js db:dump --format=mysql --output=migrate-to-mysql.sql
+
+# Step 2: Create MySQL database
+mysql -e "CREATE DATABASE sqlew_db CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
+
+# Step 3: Import dump
+mysql sqlew_db < migrate-to-mysql.sql
+```
+
+### Workflow 4: Consolidate Multiple Projects (Permission-Constrained)
+
+```bash
+# Export from each project
+cd ~/project-a && node node_modules/sqlew/dist/cli.js db:export --project=project-a --output=/tmp/a.json
+cd ~/project-b && node node_modules/sqlew/dist/cli.js db:export --project=project-b --output=/tmp/b.json
+
+# Import all to shared database
+cd ~/shared-db
+node node_modules/sqlew/dist/cli.js db:import --source=/tmp/a.json
+node node_modules/sqlew/dist/cli.js db:import --source=/tmp/b.json
+```
+
+## Getting Help
+
+Show command-specific help:
+
+```bash
+node node_modules/sqlew/dist/cli.js db:dump --help
+node node_modules/sqlew/dist/cli.js db:export --help
+node node_modules/sqlew/dist/cli.js db:import --help
+```
+
+## Detailed Documentation
+
+- **[DATABASE_MIGRATION.md](DATABASE_MIGRATION.md)** - Complete `db:dump` reference
+    - SQL dump generation for all database types
+    - Data type mappings
+    - Transaction safety
+    - Conflict resolution
+
+- **[DATA_EXPORT_IMPORT.md](DATA_EXPORT_IMPORT.md)** - Complete `db:export`/`db:import` reference
+    - JSON export/import system
+    - ID remapping strategy
+    - Multi-project consolidation
+    - Use cases and examples
+
+## See Also
+
+- [Main README](../../README.md) - MCP server setup and usage
+- [Configuration Guide](../CONFIGURATION.md) - Database configuration options
+- [Architecture](../ARCHITECTURE.md) - Technical architecture overview

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sqlew",
-    "version": "3.7.4",
+    "version": "3.8.0",
     "description": "MCP server for efficient context sharing between Claude Code sub-agents (60-70% token reduction), Kanban Task Watcher, Decision or Constraint Context, and streamlined documentation",
     "main": "dist/index.js",
     "type": "module",
@@ -25,8 +25,9 @@
         "cli": "node dist/cli.js",
         "inspector": "npx @modelcontextprotocol/inspector node dist/index.js",
         "dev": "tsc --watch",
-        "clean": "rm -rf dist",
+        "clean": "rimraf dist",
         "rebuild": "npm run clean && npm run build",
+        "test": "npm run test:all-features",
         "test:all-features": "npm run build && node dist/tests/all-features.test.js",
         "test:docker": "npm run build && node --test dist/tests/multi-project-migration.test.js dist/tests/sql-dump-fk-constraints.test.js",
         "test:cross-db": "npm run build && node --test dist/tests/sql-dump-cross-database.test.js",
@@ -34,7 +35,7 @@
         "test:migration-upgrade-paths": "npm run build && node --test dist/tests/migration-upgrade-paths.test.js",
         "test:migration-idempotency": "npm run build && node --test dist/tests/migration-idempotency.test.js",
         "test:migrations:all": "npm run build && node dist/tests/migrations/test-all-versions-real.js",
-        "test:migrations:ci": "npm run build && SKIP_DOCKER_TESTS=true node dist/tests/migrations/test-all-versions-real.js",
+        "test:migrations:ci": "npm run build && node dist/tests/migrations/test-all-versions-real.js",
         "prepare": "husky",
         "prepublishOnly": "npm run rebuild",
         "knex": "tsx node_modules/.bin/knex --knexfile src/knexfile.ts",
@@ -88,6 +89,7 @@
         "husky": "^9.1.7",
         "mysql2": "^3.15.3",
         "pg": "^8.16.3",
+        "rimraf": "^6.1.0",
         "tsx": "^4.20.6",
         "typescript": "^5.0.0"
     }

package/dist/tools/config.d.ts

@@ -1,58 +0,0 @@
-/**
- * Config tool for MCP Shared Context Server
- * Manages per-project configuration with inheritance (project-specific > global)
- *
- * CONVERTED: Using Knex.js query builder only (NO knex.raw())
- */
-import { DatabaseAdapter } from '../adapters/index.js';
-/**
- * Get configuration value with per-project inheritance
- *
- * Lookup priority:
- * 1. Project-specific config (project_id = current project)
- * 2. Global config (project_id = NULL)
- *
- * @param params - Config key to retrieve
- * @param adapter - Optional database adapter (for testing)
- * @returns Config value or null if not found
- */
-export declare function getConfig(params: {
-    key: string;
-}, adapter?: DatabaseAdapter): Promise<{
-    key: string;
-    value: string | null;
-    scope: 'project' | 'global' | 'not_found';
-}>;
-/**
- * Update configuration value (project-specific or global)
- *
- * @param params - Config key, value, and optional scope
- * @param adapter - Optional database adapter (for testing)
- * @returns Success status
- */
-export declare function updateConfig(params: {
-    key: string;
-    value: string;
-    scope?: 'project' | 'global';
-}, adapter?: DatabaseAdapter): Promise<{
-    success: boolean;
-    key: string;
-    value: string;
-    scope: 'project' | 'global';
-}>;
-/**
- * Get help documentation for config tool
- * @returns Help documentation object
- */
-export declare function configHelp(): any;
-/**
- * Get comprehensive examples for config tool
- * @returns Examples documentation object
- */
-export declare function configExample(): any;
-/**
- * Get use case documentation for config tool
- * @returns Use case documentation object
- */
-export declare function configUseCase(): any;
-//# sourceMappingURL=config.d.ts.map

package/dist/tools/config.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/tools/config.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAMvD;;;;;;;;;;GAUG;AACH,wBAAsB,SAAS,CAC7B,MAAM,EAAE;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,EACvB,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,KAAK,EAAE,SAAS,GAAG,QAAQ,GAAG,WAAW,CAAA;CAAE,CAAC,CAkD3F;AAED;;;;;;GAMG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE;IACN,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;CAC9B,EACD,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,SAAS,GAAG,QAAQ,CAAA;CAAE,CAAC,CAqCxF;AAED;;;GAGG;AACH,wBAAgB,UAAU,IAAI,GAAG,CA2BhC;AAED;;;GAGG;AACH,wBAAgB,aAAa,IAAI,GAAG,CAyEnC;AAED;;;GAGG;AACH,wBAAgB,aAAa,IAAI,GAAG,CA0DnC"}