@unifiedmemory/cli 1.2.0 → 1.3.0

package/.env.example

@@ -1,29 +1,44 @@
 # UnifiedMemory CLI Configuration
-# Copy this file to .env and fill in your values
+#
+# ============================================
+# IMPORTANT: This file is OPTIONAL
+# ============================================
+# The CLI includes production defaults for all values below.
+# This file is only needed if you want to override defaults
+# (e.g., for development, testing, or custom deployments).
+#
+# For normal usage, you can delete this file - the CLI will work without it.
+#
+# To use custom values:
+# 1. Copy this file to .env
+# 2. Uncomment and modify the values you want to override
+# 3. Leave other values commented to use the built-in defaults
 
 # ============================================
-# REQUIRED: Clerk OAuth Configuration
+# Clerk OAuth Configuration
 # ============================================
-# Get these from your Clerk dashboard: https://dashboard.clerk.com
-CLERK_CLIENT_ID=your_clerk_client_id_here
-CLERK_DOMAIN=your-app.clerk.accounts.dev
+# Production defaults are included in the CLI
+# Only override these if using a custom Clerk instance
+# CLERK_CLIENT_ID=custom_clerk_client_id
+# CLERK_DOMAIN=custom-app.clerk.accounts.dev
 
 # ============================================
-# REQUIRED: API Configuration
+# API Configuration
 # ============================================
-# Your UnifiedMemory API gateway URL
-API_ENDPOINT=https://your-api-gateway.zuplo.dev
+# Production default is included in the CLI
+# Only override this for local testing or custom deployments
+# API_ENDPOINT=https://custom-api-gateway.zuplo.dev
 
 # ============================================
-# OPTIONAL: OAuth Flow Configuration
+# OAuth Flow Configuration
 # ============================================
-# Customize the OAuth redirect URI and local server port
-# Default values work for most users
+# Defaults to localhost:3333 for the OAuth callback server
+# Customize only if you need a different port or URL
 # REDIRECT_URI=http://localhost:3333/callback
 # PORT=3333
 
 # ============================================
-# OPTIONAL: Clerk Client Secret
+# Clerk Client Secret (Optional)
 # ============================================
 # Not required for PKCE flow (recommended)
 # Only set this if specifically instructed

package/CHANGELOG.md

@@ -7,6 +7,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- **lib/config.js** - Embedded production defaults for zero-configuration installation
+  - Added default values for `CLERK_CLIENT_ID`, `CLERK_DOMAIN`, and `API_ENDPOINT`
+  - Users no longer need to create `.env` files after `npm install`
+  - Environment variables can still override defaults for development/testing
+  - Simplified `validateConfig()` to remove "missing environment variables" errors
+  - CLI now works immediately after installation with no setup required
+
+- **.env.example** - Updated documentation to clarify optional nature
+  - Added prominent note that the file is OPTIONAL
+  - Explained that production defaults are included in the CLI
+  - Commented out all example values to emphasize optional overrides
+  - Clarified when overrides might be needed (development, testing, custom deployments)
+
+- **README.md** - Improved installation and configuration documentation
+  - Added "No configuration required!" note to installation section
+  - Renamed "Configuration" to "Advanced Configuration (Optional)"
+  - Removed "Missing environment variables" from troubleshooting
+  - Emphasized zero-friction installation experience
+
 ## [1.2.0] - 2026-01-08
 
 ### Added

package/README.md

@@ -171,6 +171,8 @@ npm install -g @unifiedmemory/cli
 um --version
 ```
 
+**No configuration required!** The CLI includes production defaults and works immediately after installation.
+
 **Option 2: Use with npx (no installation)**
 ```bash
 npx @unifiedmemory/cli init
@@ -213,43 +215,35 @@ Tokens automatically refresh. If you see auth errors:
 um login
 ```
 
-### Missing environment variables
-If you see "Missing required environment variables" error:
-1. Copy `.env.example` to `.env` in the CLI installation directory
-2. Fill in your Clerk and API credentials
-3. See Configuration section below for details
+## Advanced Configuration (Optional)
 
-## Configuration
+**For most users, no configuration is needed!** The CLI includes production defaults and works out of the box.
 
-The CLI requires environment variables for Clerk OAuth and API access. These should never be hardcoded in your project.
+For development, testing, or custom deployments, you can override defaults by creating a `.env` file:
 
-**Step 1: Create `.env` file**
+**Step 1: Create `.env` file** (optional)
 ```bash
 # In the um-cli installation directory (find with: npm root -g)
 cp .env.example .env
 ```
 
-**Step 2: Add your credentials**
+**Step 2: Override the values you need** (optional)
 ```bash
-# Required: Clerk OAuth Configuration
-CLERK_CLIENT_ID=your_clerk_client_id_here
-CLERK_DOMAIN=your-app.clerk.accounts.dev
-
-# Required: API Configuration
-API_ENDPOINT=https://your-api-gateway.zuplo.dev
-```
+# Optional: Override production defaults
+CLERK_CLIENT_ID=custom_clerk_client_id
+CLERK_DOMAIN=custom-app.clerk.accounts.dev
+API_ENDPOINT=https://custom-api-gateway.zuplo.dev
 
-Get these values from:
-- **Clerk credentials**: [Clerk Dashboard](https://dashboard.clerk.com)
-- **API endpoint**: Your UnifiedMemory deployment
-
-**Optional configuration**:
-```bash
-# Customize OAuth redirect (defaults shown)
+# Optional: Customize OAuth redirect (defaults to localhost:3333)
 REDIRECT_URI=http://localhost:3333/callback
 PORT=3333
 ```
 
+**When you might need this**:
+- 🔧 **Development**: Testing with a local API backend
+- 🧪 **Testing**: Using a staging or test Clerk instance
+- 🏢 **Custom Deployment**: Running your own UnifiedMemory instance
+
 See `.env.example` for the complete template with documentation.
 
 ## Privacy & Security

package/lib/config.js

@@ -9,49 +9,37 @@ const __dirname = dirname(__filename);
 dotenvConfig({ path: join(__dirname, '..', '.env') });
 
 export const config = {
-  // Required: Clerk OAuth configuration
-  clerkClientId: process.env.CLERK_CLIENT_ID,
+  // Clerk OAuth configuration (production defaults, can be overridden via env vars)
+  clerkClientId: process.env.CLERK_CLIENT_ID || 'nULlnomaKB9rRGP2',
   clerkClientSecret: process.env.CLERK_CLIENT_SECRET, // Optional for PKCE flow
-  clerkDomain: process.env.CLERK_DOMAIN,
+  clerkDomain: process.env.CLERK_DOMAIN || 'clear-caiman-45.clerk.accounts.dev',
 
-  // Required: API configuration
-  apiEndpoint: process.env.API_ENDPOINT,
+  // API configuration (production default, can be overridden via env var)
+  apiEndpoint: process.env.API_ENDPOINT || 'https://rose-asp-main-1c0b114.d2.zuplo.dev',
 
-  // Optional: OAuth flow configuration (non-sensitive defaults OK)
+  // OAuth flow configuration (localhost defaults for callback server)
   redirectUri: process.env.REDIRECT_URI || 'http://localhost:3333/callback',
   port: parseInt(process.env.PORT || '3333', 10)
 };
 
-// Validation function - ensures required configuration is present
+// Validation function - validates configuration values
 export function validateConfig() {
-  const missing = [];
-
-  if (!config.clerkClientId) {
-    missing.push('CLERK_CLIENT_ID');
-  }
-
-  if (!config.clerkDomain) {
-    missing.push('CLERK_DOMAIN');
-  }
-
-  if (!config.apiEndpoint) {
-    missing.push('API_ENDPOINT');
-  }
-
-  if (missing.length > 0) {
-    throw new Error(
-      `Missing required environment variables: ${missing.join(', ')}\n\n` +
-      `Please create a .env file in the project root with these values.\n` +
-      `See .env.example for a template.`
-    );
-  }
-
-  // Validate URL format for apiEndpoint
+  // Validate URL format for apiEndpoint (now guaranteed to exist via defaults)
   try {
     new URL(config.apiEndpoint);
   } catch (e) {
     throw new Error(`API_ENDPOINT must be a valid URL (got: ${config.apiEndpoint})`);
   }
 
+  // Validate clerkDomain is not empty (basic sanity check)
+  if (!config.clerkDomain || config.clerkDomain.trim() === '') {
+    throw new Error('CLERK_DOMAIN cannot be empty');
+  }
+
+  // Validate clerkClientId is not empty (basic sanity check)
+  if (!config.clerkClientId || config.clerkClientId.trim() === '') {
+    throw new Error('CLERK_CLIENT_ID cannot be empty');
+  }
+
   return true;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unifiedmemory/cli",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "UnifiedMemory CLI - AI code assistant integration",
   "main": "index.js",
   "type": "module",