spindb 0.7.0 → 0.7.5

package/cli/commands/backup.ts

@@ -15,18 +15,11 @@ import { createSpinner } from '../ui/spinner'
 import { success, error, warning, formatBytes } from '../ui/theme'
 import { getMissingDependencies } from '../../core/dependency-manager'
 
-/**
- * Generate a timestamp string for backup filenames
- * Format: YYYY-MM-DDTHHMMSS (ISO 8601 without colons for filesystem compatibility)
- */
 function generateTimestamp(): string {
   const now = new Date()
   return now.toISOString().replace(/:/g, '').split('.')[0]
 }
 
-/**
- * Generate default backup filename
- */
 function generateDefaultFilename(
   containerName: string,
   database: string,
@@ -35,9 +28,6 @@ function generateDefaultFilename(
   return `${containerName}-${database}-backup-${timestamp}`
 }
 
-/**
- * Get file extension for backup format
- */
 function getExtension(format: 'sql' | 'dump', engine: string): string {
   if (format === 'sql') {
     return '.sql'
@@ -73,7 +63,6 @@ export const backupCommand = new Command('backup')
       try {
         let containerName = containerArg
 
-        // Interactive selection if no container provided
         if (!containerName) {
           const containers = await containerManager.list()
           const running = containers.filter((c) => c.status === 'running')
@@ -101,7 +90,6 @@ export const backupCommand = new Command('backup')
           containerName = selected
         }
 
-        // Get container config
         const config = await containerManager.getConfig(containerName)
         if (!config) {
           console.error(error(`Container "${containerName}" not found`))
@@ -110,7 +98,6 @@ export const backupCommand = new Command('backup')
 
         const { engine: engineName } = config
 
-        // Check if running
         const running = await processManager.isRunning(containerName, {
           engine: engineName,
         })
@@ -123,10 +110,8 @@ export const backupCommand = new Command('backup')
           process.exit(1)
         }
 
-        // Get engine
         const engine = getEngine(engineName)
 
-        // Check for required client tools
         const depsSpinner = createSpinner('Checking required tools...')
         depsSpinner.start()
 
@@ -136,7 +121,6 @@ export const backupCommand = new Command('backup')
             `Missing tools: ${missingDeps.map((d) => d.name).join(', ')}`,
           )
 
-          // Offer to install
           const installed = await promptInstallDependencies(
             missingDeps[0].binary,
             config.engine,
@@ -146,7 +130,6 @@ export const backupCommand = new Command('backup')
             process.exit(1)
           }
 
-          // Verify installation worked
           missingDeps = await getMissingDependencies(config.engine)
           if (missingDeps.length > 0) {
             console.error(
@@ -163,27 +146,22 @@ export const backupCommand = new Command('backup')
           depsSpinner.succeed('Required tools available')
         }
 
-        // Determine which database to backup
         let databaseName = options.database
 
         if (!databaseName) {
-          // Get list of databases in container
           const databases = config.databases || [config.database]
 
           if (databases.length > 1) {
-            // Interactive mode: prompt for database selection
             databaseName = await promptDatabaseSelect(
               databases,
               'Select database to backup:',
             )
           } else {
-            // Single database: use it
             databaseName = databases[0]
           }
         }
 
-        // Determine format
-        let format: 'sql' | 'dump' = 'sql' // Default to SQL
+        let format: 'sql' | 'dump' = 'sql'
 
         if (options.sql) {
           format = 'sql'
@@ -196,28 +174,23 @@ export const backupCommand = new Command('backup')
           }
           format = options.format as 'sql' | 'dump'
         } else if (!containerArg) {
-          // Interactive mode: prompt for format
           format = await promptBackupFormat(engineName)
         }
 
-        // Determine filename
         const defaultFilename = generateDefaultFilename(
           containerName,
           databaseName,
         )
         let filename = options.name || defaultFilename
 
-        // In interactive mode with no name provided, optionally prompt for custom name
         if (!containerArg && !options.name) {
           filename = await promptBackupFilename(defaultFilename)
         }
 
-        // Build full output path
         const extension = getExtension(format, engineName)
         const outputDir = options.output || process.cwd()
         const outputPath = join(outputDir, `${filename}${extension}`)
 
-        // Create backup
         const backupSpinner = createSpinner(
           `Creating ${format === 'sql' ? 'SQL' : 'dump'} backup of "${databaseName}"...`,
         )
@@ -230,7 +203,6 @@ export const backupCommand = new Command('backup')
 
         backupSpinner.succeed('Backup created successfully')
 
-        // Show result
         console.log()
         console.log(success('Backup complete'))
         console.log()
@@ -244,7 +216,6 @@ export const backupCommand = new Command('backup')
       } catch (err) {
         const e = err as Error
 
-        // Check if this is a missing tool error
         const missingToolPatterns = ['pg_dump not found', 'mysqldump not found']
 
         const matchingPattern = missingToolPatterns.find((p) =>

package/cli/commands/clone.ts

@@ -16,7 +16,6 @@ export const cloneCommand = new Command('clone')
       let sourceName = source
       let targetName = target
 
-      // Interactive selection if no source provided
       if (!sourceName) {
         const containers = await containerManager.list()
         const stopped = containers.filter((c) => c.status !== 'running')
@@ -50,14 +49,12 @@ export const cloneCommand = new Command('clone')
         sourceName = selected
       }
 
-      // Check source exists
       const sourceConfig = await containerManager.getConfig(sourceName)
       if (!sourceConfig) {
         console.error(error(`Container "${sourceName}" not found`))
         process.exit(1)
       }
 
-      // Check source is stopped
       const running = await processManager.isRunning(sourceName, {
         engine: sourceConfig.engine,
       })
@@ -70,12 +67,10 @@ export const cloneCommand = new Command('clone')
         process.exit(1)
       }
 
-      // Get target name
       if (!targetName) {
         targetName = await promptContainerName(`${sourceName}-copy`)
       }
 
-      // Clone the container
       const cloneSpinner = createSpinner(
         `Cloning ${sourceName} to ${targetName}...`,
       )
@@ -85,7 +80,6 @@ export const cloneCommand = new Command('clone')
 
       cloneSpinner.succeed(`Cloned "${sourceName}" to "${targetName}"`)
 
-      // Get engine for connection string
       const engine = getEngine(newConfig.engine)
       const connectionString = engine.getConnectionString(newConfig)
 

package/cli/commands/config.ts

@@ -45,10 +45,16 @@ export const configCommand = new Command('config')
   .addCommand(
     new Command('show')
       .description('Show current configuration')
-      .action(async () => {
+      .option('--json', 'Output as JSON')
+      .action(async (options: { json?: boolean }) => {
         try {
           const config = await configManager.getConfig()
 
+          if (options.json) {
+            console.log(JSON.stringify(config, null, 2))
+            return
+          }
+
           console.log()
           console.log(header('SpinDB Configuration'))
           console.log()

package/cli/commands/connect.ts

@@ -21,6 +21,7 @@ import { promptContainerSelect } from '../ui/prompts'
 import { error, warning, info, success } from '../ui/theme'
 
 export const connectCommand = new Command('connect')
+  .alias('shell')
   .description('Connect to a container with database client')
   .argument('[name]', 'Container name')
   .option('-d, --database <name>', 'Database name')
@@ -52,7 +53,6 @@ export const connectCommand = new Command('connect')
       try {
         let containerName = name
 
-        // Interactive selection if no name provided
         if (!containerName) {
           const containers = await containerManager.list()
           const running = containers.filter((c) => c.status === 'running')
@@ -80,7 +80,6 @@ export const connectCommand = new Command('connect')
           containerName = selected
         }
 
-        // Get container config
         const config = await containerManager.getConfig(containerName)
         if (!config) {
           console.error(error(`Container "${containerName}" not found`))
@@ -90,11 +89,9 @@ export const connectCommand = new Command('connect')
         const { engine: engineName } = config
         const engineDefaults = getEngineDefaults(engineName)
 
-        // Default database: container's database or superuser
         const database =
           options.database ?? config.database ?? engineDefaults.superuser
 
-        // Check if running
         const running = await processManager.isRunning(containerName, {
           engine: engineName,
         })
@@ -107,18 +104,15 @@ export const connectCommand = new Command('connect')
           process.exit(1)
         }
 
-        // Get engine
         const engine = getEngine(engineName)
         const connectionString = engine.getConnectionString(config, database)
 
-        // Handle --tui and --install-tui flags (usql)
         const useUsql = options.tui || options.installTui
         if (useUsql) {
           const usqlInstalled = await isUsqlInstalled()
 
           if (!usqlInstalled) {
             if (options.installTui) {
-              // Try to install usql
               console.log(
                 info('Installing usql for enhanced shell experience...'),
               )
@@ -149,7 +143,6 @@ export const connectCommand = new Command('connect')
                 process.exit(1)
               }
             } else {
-              // --tui flag but usql not installed
               console.error(error('usql is not installed'))
               console.log()
               console.log(
@@ -166,7 +159,6 @@ export const connectCommand = new Command('connect')
           }
         }
 
-        // Handle --pgcli and --install-pgcli flags
         const usePgcli = options.pgcli || options.installPgcli
         if (usePgcli) {
           if (engineName !== 'postgresql') {
@@ -227,7 +219,6 @@ export const connectCommand = new Command('connect')
           }
         }
 
-        // Handle --mycli and --install-mycli flags
         const useMycli = options.mycli || options.installMycli
         if (useMycli) {
           if (engineName !== 'mysql') {
@@ -287,16 +278,13 @@ export const connectCommand = new Command('connect')
         console.log(info(`Connecting to ${containerName}:${database}...`))
         console.log()
 
-        // Build client command based on engine and shell preference
         let clientCmd: string
         let clientArgs: string[]
 
         if (usePgcli) {
-          // pgcli accepts connection strings
           clientCmd = 'pgcli'
           clientArgs = [connectionString]
         } else if (useMycli) {
-          // mycli: mycli -h host -P port -u user database
           clientCmd = 'mycli'
           clientArgs = [
             '-h',
@@ -308,11 +296,9 @@ export const connectCommand = new Command('connect')
             database,
           ]
         } else if (useUsql) {
-          // usql accepts connection strings directly for both PostgreSQL and MySQL
           clientCmd = 'usql'
           clientArgs = [connectionString]
         } else if (engineName === 'mysql') {
-          // MySQL: mysql -h 127.0.0.1 -P port -u root database
           clientCmd = 'mysql'
           clientArgs = [
             '-h',
@@ -324,7 +310,6 @@ export const connectCommand = new Command('connect')
             database,
           ]
         } else {
-          // PostgreSQL: psql connection_string
           clientCmd = 'psql'
           clientArgs = [connectionString]
         }

package/cli/commands/create.ts

@@ -22,15 +22,10 @@ import { startWithRetry } from '../../core/start-with-retry'
 import { TransactionManager } from '../../core/transaction-manager'
 import { Engine } from '../../types'
 
-/**
- * Detect if a location string is a connection string or a file path
- * Also infers engine from connection string scheme
- */
 function detectLocationType(location: string): {
   type: 'connection' | 'file' | 'not_found'
   inferredEngine?: Engine
 } {
-  // Check for PostgreSQL connection string
   if (
     location.startsWith('postgresql://') ||
     location.startsWith('postgres://')
@@ -38,12 +33,10 @@ function detectLocationType(location: string): {
     return { type: 'connection', inferredEngine: Engine.PostgreSQL }
   }
 
-  // Check for MySQL connection string
   if (location.startsWith('mysql://')) {
     return { type: 'connection', inferredEngine: Engine.MySQL }
   }
 
-  // Check if file exists
   if (existsSync(location)) {
     return { type: 'file' }
   }
@@ -83,7 +76,6 @@ export const createCommand = new Command('create')
         let version = options.version
         let database = options.database
 
-        // Validate --from location if provided (before prompts so we can infer engine)
         let restoreLocation: string | null = null
         let restoreType: 'connection' | 'file' | null = null
 
@@ -103,7 +95,6 @@ export const createCommand = new Command('create')
           restoreLocation = options.from
           restoreType = locationInfo.type
 
-          // Infer engine from connection string if not explicitly set
           if (!options.engine && locationInfo.inferredEngine) {
             engine = locationInfo.inferredEngine
             console.log(
@@ -113,7 +104,6 @@ export const createCommand = new Command('create')
             )
           }
 
-          // If using --from, we must start the container
           if (options.start === false) {
             console.error(
               error(
@@ -124,15 +114,12 @@ export const createCommand = new Command('create')
           }
         }
 
-        // Get engine defaults for port range and default version
         const engineDefaults = getEngineDefaults(engine)
 
-        // Set version to engine default if not specified
         if (!version) {
           version = engineDefaults.defaultVersion
         }
 
-        // Interactive mode if no name provided
         if (!containerName) {
           const answers = await promptCreateOptions()
           containerName = answers.name
@@ -141,16 +128,13 @@ export const createCommand = new Command('create')
           database = answers.database
         }
 
-        // Default database name to container name if not specified
         database = database ?? containerName
 
         console.log(header('Creating Database Container'))
         console.log()
 
-        // Get the engine
         const dbEngine = getEngine(engine)
 
-        // Check for required client tools BEFORE creating anything
         const depsSpinner = createSpinner('Checking required tools...')
         depsSpinner.start()
 
@@ -160,7 +144,6 @@ export const createCommand = new Command('create')
             `Missing tools: ${missingDeps.map((d) => d.name).join(', ')}`,
           )
 
-          // Offer to install
           const installed = await promptInstallDependencies(
             missingDeps[0].binary,
             engine,
@@ -170,7 +153,6 @@ export const createCommand = new Command('create')
             process.exit(1)
           }
 
-          // Verify installation worked
           missingDeps = await getMissingDependencies(engine)
           if (missingDeps.length > 0) {
             console.error(
@@ -187,7 +169,6 @@ export const createCommand = new Command('create')
           depsSpinner.succeed('Required tools available')
         }
 
-        // Find available port
         const portSpinner = createSpinner('Finding available port...')
         portSpinner.start()
 
@@ -216,7 +197,6 @@ export const createCommand = new Command('create')
           }
         }
 
-        // Ensure binaries are available
         const binarySpinner = createSpinner(
           `Checking ${dbEngine.displayName} ${version} binaries...`,
         )
@@ -237,7 +217,6 @@ export const createCommand = new Command('create')
           )
         }
 
-        // Check if container name already exists and prompt for new name if needed
         while (await containerManager.exists(containerName)) {
           console.log(
             chalk.yellow(`  Container "${containerName}" already exists.`),
@@ -245,10 +224,8 @@ export const createCommand = new Command('create')
           containerName = await promptContainerName()
         }
 
-        // Create transaction manager for rollback support
         const tx = new TransactionManager()
 
-        // Create container
         const createSpinnerInstance = createSpinner('Creating container...')
         createSpinnerInstance.start()
 
@@ -260,7 +237,6 @@ export const createCommand = new Command('create')
             database,
           })
 
-          // Register rollback action for container deletion
           tx.addRollback({
             description: `Delete container "${containerName}"`,
             execute: async () => {
@@ -274,7 +250,6 @@ export const createCommand = new Command('create')
           throw err
         }
 
-        // Initialize database cluster
         const initSpinner = createSpinner('Initializing database cluster...')
         initSpinner.start()
 
@@ -282,7 +257,6 @@ export const createCommand = new Command('create')
           await dbEngine.initDataDir(containerName, version, {
             superuser: engineDefaults.superuser,
           })
-          // Note: initDataDir is covered by the container delete rollback
           initSpinner.succeed('Database cluster initialized')
         } catch (err) {
           initSpinner.fail('Failed to initialize database cluster')
@@ -290,27 +264,19 @@ export const createCommand = new Command('create')
           throw err
         }
 
-        // Determine if we should start the container
-        // If --from is specified, we must start to restore
-        // If --no-start is specified, don't start
-        // Otherwise, ask the user
+        // --from requires start, --no-start skips, otherwise ask user
         let shouldStart = false
         if (restoreLocation) {
-          // Must start to restore data
           shouldStart = true
         } else if (options.start === false) {
-          // User explicitly requested no start
           shouldStart = false
         } else {
-          // Ask the user
           console.log()
           shouldStart = await promptConfirm(`Start ${containerName} now?`, true)
         }
 
-        // Get container config for starting and restoration
         const config = await containerManager.getConfig(containerName)
 
-        // Start container if requested
         if (shouldStart && config) {
           const startSpinner = createSpinner(
             `Starting ${dbEngine.displayName}...`,
@@ -318,7 +284,6 @@ export const createCommand = new Command('create')
           startSpinner.start()
 
           try {
-            // Use startWithRetry to handle port race conditions
             const result = await startWithRetry({
               engine: dbEngine,
               config,
@@ -337,7 +302,6 @@ export const createCommand = new Command('create')
               throw new Error('Failed to start container')
             }
 
-            // Register rollback action for stopping the container
             tx.addRollback({
               description: `Stop container "${containerName}"`,
               execute: async () => {
@@ -370,8 +334,7 @@ export const createCommand = new Command('create')
             throw err
           }
 
-          // Create the user's database (if different from default)
-          const defaultDb = engineDefaults.superuser // postgres or root
+          const defaultDb = engineDefaults.superuser
           if (database !== defaultDb) {
             const dbSpinner = createSpinner(
               `Creating database "${database}"...`,
@@ -389,18 +352,16 @@ export const createCommand = new Command('create')
           }
         }
 
-        // Handle --from restore if specified (only if started)
         if (restoreLocation && restoreType && config && shouldStart) {
           let backupPath = ''
 
           if (restoreType === 'connection') {
-            // Create dump from remote database
             const timestamp = Date.now()
             tempDumpPath = join(tmpdir(), `spindb-dump-${timestamp}.dump`)
 
             let dumpSuccess = false
             let attempts = 0
-            const maxAttempts = 2 // Allow one retry after installing deps
+            const maxAttempts = 2
 
             while (!dumpSuccess && attempts < maxAttempts) {
               attempts++
@@ -421,7 +382,6 @@ export const createCommand = new Command('create')
                 const e = err as Error
                 dumpSpinner.fail('Failed to create dump')
 
-                // Check if this is a missing tool error
                 if (
                   e.message.includes('pg_dump not found') ||
                   e.message.includes('ENOENT')
@@ -430,7 +390,6 @@ export const createCommand = new Command('create')
                   if (!installed) {
                     process.exit(1)
                   }
-                  // Loop will retry
                   continue
                 }
 
@@ -441,7 +400,6 @@ export const createCommand = new Command('create')
               }
             }
 
-            // Safety check - should never reach here without backupPath set
             if (!dumpSuccess) {
               console.error(error('Failed to create dump after retries'))
               process.exit(1)
@@ -450,20 +408,18 @@ export const createCommand = new Command('create')
             backupPath = restoreLocation
           }
 
-          // Detect backup format
           const detectSpinner = createSpinner('Detecting backup format...')
           detectSpinner.start()
 
           const format = await dbEngine.detectBackupFormat(backupPath)
           detectSpinner.succeed(`Detected: ${format.description}`)
 
-          // Restore backup
           const restoreSpinner = createSpinner('Restoring backup...')
           restoreSpinner.start()
 
           const result = await dbEngine.restore(config, backupPath, {
             database,
-            createDatabase: false, // Already created above
+            createDatabase: false,
           })
 
           if (result.code === 0 || !result.stderr) {
@@ -485,10 +441,8 @@ export const createCommand = new Command('create')
           }
         }
 
-        // Commit the transaction - all operations succeeded
         tx.commit()
 
-        // Show success message
         const finalConfig = await containerManager.getConfig(containerName)
         if (finalConfig) {
           const connectionString = dbEngine.getConnectionString(finalConfig)
@@ -503,7 +457,6 @@ export const createCommand = new Command('create')
             console.log(chalk.gray('  Connect with:'))
             console.log(chalk.cyan(`  spindb connect ${containerName}`))
 
-            // Copy connection string to clipboard
             const copied =
               await platformService.copyToClipboard(connectionString)
             if (copied) {
@@ -519,13 +472,10 @@ export const createCommand = new Command('create')
       } catch (err) {
         const e = err as Error
 
-        // Check if this is a missing tool error (PostgreSQL or MySQL)
         const missingToolPatterns = [
-          // PostgreSQL
           'pg_restore not found',
           'psql not found',
           'pg_dump not found',
-          // MySQL
           'mysql not found',
           'mysqldump not found',
           'mysqld not found',
@@ -549,7 +499,6 @@ export const createCommand = new Command('create')
         console.error(error(e.message))
         process.exit(1)
       } finally {
-        // Clean up temp file if we created one
         if (tempDumpPath) {
           try {
             await rm(tempDumpPath, { force: true })

package/cli/commands/delete.ts

@@ -20,7 +20,6 @@ export const deleteCommand = new Command('delete')
       try {
         let containerName = name
 
-        // Interactive selection if no name provided
         if (!containerName) {
           const containers = await containerManager.list()
 
@@ -37,14 +36,12 @@ export const deleteCommand = new Command('delete')
           containerName = selected
         }
 
-        // Get container config
         const config = await containerManager.getConfig(containerName)
         if (!config) {
           console.error(error(`Container "${containerName}" not found`))
           process.exit(1)
         }
 
-        // Confirm deletion
         if (!options.yes) {
           const confirmed = await promptConfirm(
             `Are you sure you want to delete "${containerName}"? This cannot be undone.`,
@@ -56,13 +53,11 @@ export const deleteCommand = new Command('delete')
           }
         }
 
-        // Check if running
         const running = await processManager.isRunning(containerName, {
           engine: config.engine,
         })
         if (running) {
           if (options.force) {
-            // Stop the container first
             const stopSpinner = createSpinner(`Stopping ${containerName}...`)
             stopSpinner.start()
 
@@ -80,7 +75,6 @@ export const deleteCommand = new Command('delete')
           }
         }
 
-        // Delete the container
         const deleteSpinner = createSpinner(`Deleting ${containerName}...`)
         deleteSpinner.start()