@multisystemsuite/cli

Command-line interface for the Database Reliability Toolkit. Binary name: db-toolkit.

Version: 1.0.1 · License: MIT

npm readme: @multisystemsuite/cli on npm

Installation

npm install -g @multisystemsuite/cli
# or run without install:
npx @multisystemsuite/cli <command>

Requires: Node.js ≥ 20

Quick start

db-toolkit init
db-toolkit analyze -f ./queries.sql -t 1000
db-toolkit health
db-toolkit report -o report.json

Commands

init

Creates project config and migrations folder.

db-toolkit init

Creates:

• db-toolkit.config.json — service name, thresholds, paths
• migrations/ — empty migrations directory

analyze

Analyze SQL for performance issues.

db-toolkit analyze [options]

| Option | Description | |--------|-------------| | -f, --file <path> | SQL file (statements split by ;) | | -t, --threshold <ms> | Slow query threshold (default: 1000) |

Output: JSON per query with severity, score, issue, recommendation.

migrate

Manage SQL migrations (powered by @multisystemsuite/db-migrator).

db-toolkit migrate [action] [options]

| Action | Description | |--------|-------------| | create | New migration file (requires -n) | | up | Apply pending (default) | | down | Roll back last migration |

| Option | Description | |--------|-------------| | -n, --name <name> | Migration name for create | | -d, --dir <path> | Migrations dir (default: ./migrations) | | --dry-run | Simulate without applying |

Examples:

db-toolkit migrate create -n add_index_users_email
db-toolkit migrate up
db-toolkit migrate down --dry-run

monitor

Print Prometheus-format metrics snapshot.

db-toolkit monitor

Pipe to file or scrape once:

db-toolkit monitor > metrics.txt

health

Run built-in health checks (connection, replication, storage samples).

db-toolkit health

Output:

{ "score": 92, "status": "healthy" }

scan

Security scan for SQL injection and secrets.

db-toolkit scan [options]

| Option | Description | |--------|-------------| | -f, --file <path> | Additional file to scan for secrets |

Output: JSON with summary and findings array.

report

Generate combined performance & reliability report.

db-toolkit report [options]

| Option | Description | |--------|-------------| | -o, --output <path> | Write JSON to file instead of stdout |

Report includes: slow queries, index recommendations, health, observability dashboard, connection analytics, cache stats.

Programmatic use

Command handlers are exported for testing/automation:

import { runInit, runAnalyze, runMigrate } from '@multisystemsuite/cli';

Configuration file

db-toolkit.config.json (created by init):

{
  "version": 1,
  "serviceName": "my-app",
  "queryThreshold": 1000,
  "migrationsDir": "./migrations",
  "observability": {
    "prometheus": true,
    "openTelemetry": true
  }
}

Related packages

See the @multisystemsuite org on npm.

npm

• Package: @multisystemsuite/cli
• Install: npm install @multisystemsuite/cli