lsh-framework 1.3.2 → 1.4.1

package/.env.example

@@ -1,5 +1,16 @@
-# LSH Shell - Environment Configuration
-# Copy this file to .env and update with your actual values
+# LSH Shell - Environment Configuration (DEPRECATED for LSH config)
+#
+# ⚠️  IMPORTANT: LSH configuration should now be in ~/.config/lsh/lshrc
+#
+# Use: lsh config              # Edit configuration
+#      lsh config set KEY val  # Set individual values
+#
+# This .env.example file is kept for reference and backward compatibility.
+# For new installations, use: lsh config init
+#
+# Priority: Environment variables > ~/.config/lsh/lshrc > defaults
+#
+# Use .env files ONLY for application secrets, NOT for LSH configuration
 
 # Core Configuration
 USER=your_username
@@ -28,7 +39,7 @@ JENKINS_WEBHOOK_SECRET=
 # Database Configuration
 DATABASE_URL=postgresql://localhost:5432/cicd
 
-# Supabase (Optional)
+# Supabase (REQUIRED for SaaS Platform, optional otherwise)
 SUPABASE_URL=
 SUPABASE_ANON_KEY=
 
@@ -44,8 +55,37 @@ ENABLE_ARCHIVE=false
 ARCHIVE_S3_BUCKET=
 ARCHIVE_LOCAL_PATH=/var/backups/cicd
 
+# ============================================================================
+# SaaS Platform Configuration
+# ============================================================================
+
+# SaaS API Server
+LSH_SAAS_API_PORT=3031
+LSH_SAAS_API_HOST=0.0.0.0
+LSH_CORS_ORIGINS=http://localhost:3000,http://localhost:3031
+
+# Master Encryption Key (REQUIRED - for encrypting team encryption keys)
+# Generate with: openssl rand -hex 32
+LSH_MASTER_KEY=
+# Alternative: use existing secrets key
+# LSH_SECRETS_KEY=
+
+# Email Service (Resend)
+RESEND_API_KEY=
+EMAIL_FROM=noreply@yourdomain.com
+BASE_URL=https://app.yourdomain.com
+
+# Stripe Billing
+STRIPE_SECRET_KEY=
+STRIPE_WEBHOOK_SECRET=
+STRIPE_PRICE_PRO_MONTHLY=
+STRIPE_PRICE_PRO_YEARLY=
+STRIPE_PRICE_ENTERPRISE_MONTHLY=
+STRIPE_PRICE_ENTERPRISE_YEARLY=
+
 # Security Notes:
 # - Generate secrets: openssl rand -hex 32
 # - Never commit .env file
 # - Webhook secrets mandatory in production
 # - Rotate keys regularly
+# - LSH_MASTER_KEY is critical - keep it secure and backed up

package/README.md

@@ -17,15 +17,36 @@ Traditional secret management tools are either too complex, too expensive, or re
 
 **Plus, you get a complete shell automation platform as a bonus.**
 
-## Quick Start (30 seconds)
+## Quick Start
 
-### New in v0.8.2+: Smart Sync (Easiest Way!)
+**New to LSH?** See our [Quick Start Guide](docs/QUICK_START.md) for three easy onboarding options:
+1. **Local-Only Mode** - Zero configuration, works immediately (no database needed)
+2. **Local PostgreSQL** - Docker-based setup for local development
+3. **Supabase Cloud** - Full team collaboration features
+
+### Quick Install (Works Immediately!)
+
+```bash
+# Install LSH
+npm install -g lsh-framework
+
+# That's it! LSH works without any database configuration
+# Config: ~/.config/lsh/lshrc (auto-created)
+# Data: ~/.lsh/data/storage.json (local storage)
+
+# Start using it right away
+lsh --version
+lsh config  # Edit configuration (optional)
+lsh daemon start
+```
+
+### Smart Sync (Easiest Way for Cloud!)
 
 ```bash
 # 1. Install
 npm install -g lsh-framework
 
-# 2. Configure Supabase (free tier works!)
+# 2. Configure Supabase (optional - free tier works!)
 # Add to .env:
 # SUPABASE_URL=https://your-project.supabase.co
 # SUPABASE_ANON_KEY=<your-anon-key>
@@ -38,7 +59,7 @@ lsh sync
 # ✅ Auto-generates encryption key
 # ✅ Creates .env from .env.example
 # ✅ Adds .env to .gitignore
-# ✅ Pushes to cloud
+# ✅ Pushes to cloud (if configured) or local storage
 # ✅ Namespaces by repo name
 ```
 

package/dist/cli.js

@@ -8,10 +8,12 @@ import selfCommand from './commands/self.js';
 import { registerInitCommands } from './commands/init.js';
 import { registerDoctorCommands } from './commands/doctor.js';
 import { registerCompletionCommands } from './commands/completion.js';
+import { registerConfigCommands } from './commands/config.js';
 import { init_daemon } from './services/daemon/daemon.js';
 import { init_supabase } from './services/supabase/supabase.js';
 import { init_cron } from './services/cron/cron.js';
 import { init_secrets } from './services/secrets/secrets.js';
+import { loadGlobalConfigSync } from './lib/config-manager.js';
 import * as fs from 'fs';
 import * as path from 'path';
 import { fileURLToPath } from 'url';
@@ -72,6 +74,7 @@ program
     console.log('  lsh pull --env dev                # Pull on another machine');
     console.log('');
     console.log('📚 More Commands:');
+    console.log('  config                  Manage LSH configuration (~/.config/lsh/lshrc)');
     console.log('  supabase                Supabase database management');
     console.log('  daemon                  Daemon management');
     console.log('  cron                    Cron job management');
@@ -134,8 +137,11 @@ function findSimilarCommands(input, validCommands) {
 // Register async command modules
 (async () => {
     // Essential onboarding commands
+    // Load global configuration before anything else
+    loadGlobalConfigSync();
     registerInitCommands(program);
     registerDoctorCommands(program);
+    registerConfigCommands(program);
     // Secrets management (primary feature)
     await init_secrets(program);
     // Supporting services

package/dist/commands/config.js

@@ -0,0 +1,240 @@
+/**
+ * Configuration Management Commands
+ * Provides commands to manage LSH configuration
+ */
+import { spawn } from 'child_process';
+import { getConfigManager, loadGlobalConfig } from '../lib/config-manager.js';
+import * as fs from 'fs/promises';
+/**
+ * Get user's preferred editor
+ */
+function getEditor() {
+    return process.env.VISUAL || process.env.EDITOR || 'vi';
+}
+/**
+ * Open config file in user's editor
+ */
+async function openInEditor(filePath) {
+    const editor = getEditor();
+    return new Promise((resolve, reject) => {
+        const child = spawn(editor, [filePath], {
+            stdio: 'inherit',
+            shell: true
+        });
+        child.on('exit', (code) => {
+            if (code === 0) {
+                resolve();
+            }
+            else {
+                reject(new Error(`Editor exited with code ${code}`));
+            }
+        });
+        child.on('error', (err) => {
+            reject(err);
+        });
+    });
+}
+/**
+ * Register config commands
+ */
+export function registerConfigCommands(program) {
+    const config = program
+        .command('config')
+        .description('Manage LSH configuration');
+    // lsh config (open in editor)
+    config
+        .action(async () => {
+        try {
+            const manager = getConfigManager();
+            // Initialize if doesn't exist
+            if (!(await manager.exists())) {
+                await manager.initialize();
+            }
+            const configPath = manager.getConfigPath();
+            console.log(`Opening ${configPath} in ${getEditor()}...`);
+            await openInEditor(configPath);
+            console.log('\n✓ Config file saved');
+            console.log('  Restart LSH or run a command to apply changes');
+        }
+        catch (error) {
+            console.error('Failed to open config file:', error);
+            process.exit(1);
+        }
+    });
+    // lsh config init
+    config
+        .command('init')
+        .description('Initialize config file with default template')
+        .option('-f, --force', 'Overwrite existing config file')
+        .action(async (options) => {
+        try {
+            const manager = getConfigManager();
+            const configPath = manager.getConfigPath();
+            // Check if exists
+            const exists = await manager.exists();
+            if (exists && !options.force) {
+                console.error(`Config file already exists at ${configPath}`);
+                console.error('Use --force to overwrite');
+                process.exit(1);
+            }
+            await manager.initialize();
+        }
+        catch (error) {
+            console.error('Failed to initialize config:', error);
+            process.exit(1);
+        }
+    });
+    // lsh config path
+    config
+        .command('path')
+        .description('Show config file path')
+        .action(() => {
+        const manager = getConfigManager();
+        console.log(manager.getConfigPath());
+    });
+    // lsh config get <key>
+    config
+        .command('get <key>')
+        .description('Get a config value')
+        .action(async (key) => {
+        try {
+            const manager = getConfigManager();
+            await manager.load();
+            const value = manager.get(key);
+            if (value !== undefined) {
+                console.log(value);
+            }
+            else {
+                console.error(`Key "${key}" not found in config`);
+                process.exit(1);
+            }
+        }
+        catch (error) {
+            console.error('Failed to get config value:', error);
+            process.exit(1);
+        }
+    });
+    // lsh config set <key> <value>
+    config
+        .command('set <key> <value>')
+        .description('Set a config value')
+        .action(async (key, value) => {
+        try {
+            const manager = getConfigManager();
+            await manager.load();
+            await manager.set(key, value);
+            console.log(`✓ Set ${key}=${value}`);
+        }
+        catch (error) {
+            console.error('Failed to set config value:', error);
+            process.exit(1);
+        }
+    });
+    // lsh config delete <key>
+    config
+        .command('delete <key>')
+        .alias('rm')
+        .description('Delete a config value')
+        .action(async (key) => {
+        try {
+            const manager = getConfigManager();
+            await manager.load();
+            await manager.delete(key);
+            console.log(`✓ Deleted ${key}`);
+        }
+        catch (error) {
+            console.error('Failed to delete config value:', error);
+            process.exit(1);
+        }
+    });
+    // lsh config list
+    config
+        .command('list')
+        .alias('ls')
+        .description('List all config values')
+        .option('--show-secrets', 'Show secret values (default: masked)')
+        .action(async (options) => {
+        try {
+            const manager = getConfigManager();
+            await manager.load();
+            const allConfig = manager.getAll();
+            const keys = Object.keys(allConfig).sort();
+            if (keys.length === 0) {
+                console.log('No configuration found');
+                return;
+            }
+            console.log('\nCurrent Configuration:\n');
+            const secretKeys = [
+                'LSH_SECRETS_KEY',
+                'LSH_MASTER_KEY',
+                'LSH_API_KEY',
+                'LSH_JWT_SECRET',
+                'SUPABASE_ANON_KEY',
+                'GITHUB_WEBHOOK_SECRET',
+                'GITLAB_WEBHOOK_SECRET',
+                'JENKINS_WEBHOOK_SECRET',
+                'RESEND_API_KEY',
+                'STRIPE_SECRET_KEY',
+                'STRIPE_WEBHOOK_SECRET',
+                'DATABASE_URL'
+            ];
+            for (const key of keys) {
+                const value = allConfig[key];
+                if (value === undefined || value === '') {
+                    continue;
+                }
+                // Mask secret values unless --show-secrets is passed
+                const isSecret = secretKeys.some(sk => key.includes(sk));
+                const displayValue = (isSecret && !options.showSecrets)
+                    ? '***' + value.slice(-4)
+                    : value;
+                console.log(`  ${key}=${displayValue}`);
+            }
+            console.log();
+        }
+        catch (error) {
+            console.error('Failed to list config:', error);
+            process.exit(1);
+        }
+    });
+    // lsh config show
+    config
+        .command('show')
+        .description('Show config file contents')
+        .action(async () => {
+        try {
+            const manager = getConfigManager();
+            const configPath = manager.getConfigPath();
+            const exists = await manager.exists();
+            if (!exists) {
+                console.error(`Config file not found at ${configPath}`);
+                console.error('Run: lsh config init');
+                process.exit(1);
+            }
+            const content = await fs.readFile(configPath, 'utf-8');
+            console.log(content);
+        }
+        catch (error) {
+            console.error('Failed to show config:', error);
+            process.exit(1);
+        }
+    });
+    // lsh config reload
+    config
+        .command('reload')
+        .description('Reload config into current environment')
+        .action(async () => {
+        try {
+            const config = await loadGlobalConfig();
+            const keys = Object.keys(config).filter(k => config[k] !== undefined && config[k] !== '');
+            console.log(`✓ Reloaded ${keys.length} config values into environment`);
+            console.log('\nNote: This only affects the current LSH process.');
+            console.log('Restart daemons or shells to apply changes globally.');
+        }
+        catch (error) {
+            console.error('Failed to reload config:', error);
+            process.exit(1);
+        }
+    });
+}
+export default registerConfigCommands;