@output.ai/cli 0.5.1 → 0.5.2

package/dist/services/env_configurator.d.ts

@@ -2,10 +2,14 @@
  * Interactively configures environment variables for a project by prompting the user
  * to provide values for empty variables or variables marked as secrets.
  *
- * @param projectPath - The absolute path to the project directory containing the .env file
+ * This function reads from .env.example and, when the user confirms configuration,
+ * copies it to .env before prompting for values. The .env.example file remains
+ * unchanged as a template for other developers.
+ *
+ * @param projectPath - The absolute path to the project directory containing the .env.example file
  * @param skipPrompt - If true, skips the configuration prompt and returns false immediately
  * @returns A promise that resolves to true if environment variables were successfully configured,
- *          false if configuration was skipped (no .env file, user declined, no variables to configure,
+ *          false if configuration was skipped (no .env.example file, user declined, no variables to configure,
  *          or an error occurred)
  */
 export declare function configureEnvironmentVariables(projectPath: string, skipPrompt?: boolean): Promise<boolean>;

package/dist/services/env_configurator.js

@@ -115,10 +115,14 @@ async function writeEnvFile(filePath, variables) {
  * Interactively configures environment variables for a project by prompting the user
  * to provide values for empty variables or variables marked as secrets.
  *
- * @param projectPath - The absolute path to the project directory containing the .env file
+ * This function reads from .env.example and, when the user confirms configuration,
+ * copies it to .env before prompting for values. The .env.example file remains
+ * unchanged as a template for other developers.
+ *
+ * @param projectPath - The absolute path to the project directory containing the .env.example file
  * @param skipPrompt - If true, skips the configuration prompt and returns false immediately
  * @returns A promise that resolves to true if environment variables were successfully configured,
- *          false if configuration was skipped (no .env file, user declined, no variables to configure,
+ *          false if configuration was skipped (no .env.example file, user declined, no variables to configure,
  *          or an error occurred)
  */
 export async function configureEnvironmentVariables(projectPath, skipPrompt = false) {
@@ -126,12 +130,13 @@ export async function configureEnvironmentVariables(projectPath, skipPrompt = fa
         return false;
     }
     ux.stdout('configuring environment variables...');
+    const envExamplePath = path.join(projectPath, '.env.example');
     const envPath = path.join(projectPath, '.env');
     try {
-        await fs.access(envPath);
+        await fs.access(envExamplePath);
     }
     catch {
-        ux.stdout(ux.colorize('red', '🔴 .env file does not exist, nothing to configure'));
+        ux.stdout(ux.colorize('red', '.env.example file does not exist, nothing to configure'));
         return false;
     }
     const shouldConfigure = await confirm({
@@ -142,6 +147,8 @@ export async function configureEnvironmentVariables(projectPath, skipPrompt = fa
         return false;
     }
     try {
+        // Copy .env.example to .env before configuring
+        await fs.copyFile(envExamplePath, envPath);
         const variables = await parseEnvFile(envPath);
         const variablesToConfigure = variables.filter(v => isEmpty(v.value) || v.isSecret);
         if (variablesToConfigure.length === 0) {

package/dist/services/env_configurator.spec.js

@@ -5,16 +5,18 @@ import { configureEnvironmentVariables } from './env_configurator.js';
 // Mock inquirer prompts
 vi.mock('@inquirer/prompts', () => ({
     input: vi.fn(),
-    confirm: vi.fn()
+    confirm: vi.fn(),
+    password: vi.fn()
 }));
 describe('configureEnvironmentVariables', () => {
-    const testState = { tempDir: '', envPath: '' };
+    const testState = { tempDir: '', envExamplePath: '', envPath: '' };
     beforeEach(async () => {
         // Clear all mocks before each test
         vi.clearAllMocks();
         // Create temporary directory for test files
         testState.tempDir = path.join('/tmp', `test-env-${Date.now()}`);
         await fs.mkdir(testState.tempDir, { recursive: true });
+        testState.envExamplePath = path.join(testState.tempDir, '.env.example');
         testState.envPath = path.join(testState.tempDir, '.env');
     });
     afterEach(async () => {
@@ -27,36 +29,74 @@ describe('configureEnvironmentVariables', () => {
         }
     });
     it('should return false if skipPrompt is true', async () => {
-        // Create a minimal .env file
-        await fs.writeFile(testState.envPath, 'KEY=value');
+        // Create a minimal .env.example file
+        await fs.writeFile(testState.envExamplePath, 'KEY=value');
         const result = await configureEnvironmentVariables(testState.tempDir, true);
         expect(result).toBe(false);
     });
-    it('should return false if .env file does not exist', async () => {
+    it('should return false if .env.example file does not exist', async () => {
         const result = await configureEnvironmentVariables(testState.tempDir, false);
         expect(result).toBe(false);
     });
     it('should return false if user declines configuration', async () => {
         const { confirm } = await import('@inquirer/prompts');
         vi.mocked(confirm).mockResolvedValue(false);
-        await fs.writeFile(testState.envPath, '# API key\nAPIKEY=');
+        await fs.writeFile(testState.envExamplePath, '# API key\nAPIKEY=');
         const result = await configureEnvironmentVariables(testState.tempDir, false);
         expect(result).toBe(false);
         expect(vi.mocked(confirm)).toHaveBeenCalled();
     });
+    it('should NOT create .env when user declines configuration', async () => {
+        const { confirm } = await import('@inquirer/prompts');
+        vi.mocked(confirm).mockResolvedValue(false);
+        await fs.writeFile(testState.envExamplePath, '# API key\nAPIKEY=');
+        await configureEnvironmentVariables(testState.tempDir, false);
+        // .env should NOT exist when user declines
+        await expect(fs.access(testState.envPath)).rejects.toThrow();
+        // .env.example should still exist
+        await expect(fs.access(testState.envExamplePath)).resolves.toBeUndefined();
+    });
     it('should return false if no empty variables exist', async () => {
         const { confirm } = await import('@inquirer/prompts');
         vi.mocked(confirm).mockResolvedValue(true);
-        await fs.writeFile(testState.envPath, 'APIKEY=my-secret-key');
+        await fs.writeFile(testState.envExamplePath, 'APIKEY=my-secret-key');
         const result = await configureEnvironmentVariables(testState.tempDir, false);
         expect(result).toBe(false);
     });
+    it('should copy .env.example to .env when user confirms configuration', async () => {
+        const { input, confirm } = await import('@inquirer/prompts');
+        vi.mocked(confirm).mockResolvedValue(true);
+        vi.mocked(input).mockResolvedValueOnce('sk-proj-123');
+        const originalContent = `# API key
+APIKEY=`;
+        await fs.writeFile(testState.envExamplePath, originalContent);
+        await configureEnvironmentVariables(testState.tempDir, false);
+        // Both files should exist
+        await expect(fs.access(testState.envExamplePath)).resolves.toBeUndefined();
+        await expect(fs.access(testState.envPath)).resolves.toBeUndefined();
+    });
+    it('should write configured values to .env while leaving .env.example unchanged', async () => {
+        const { input, confirm } = await import('@inquirer/prompts');
+        vi.mocked(confirm).mockResolvedValue(true);
+        vi.mocked(input).mockResolvedValueOnce('sk-proj-123');
+        const originalContent = `# API key
+APIKEY=`;
+        await fs.writeFile(testState.envExamplePath, originalContent);
+        const result = await configureEnvironmentVariables(testState.tempDir, false);
+        expect(result).toBe(true);
+        // .env should have the configured value
+        const envContent = await fs.readFile(testState.envPath, 'utf-8');
+        expect(envContent).toContain('APIKEY=sk-proj-123');
+        // .env.example should remain unchanged
+        const envExampleContent = await fs.readFile(testState.envExamplePath, 'utf-8');
+        expect(envExampleContent).toBe(originalContent);
+    });
     it('should prompt for empty variables and update .env', async () => {
         const { input, confirm } = await import('@inquirer/prompts');
         vi.mocked(confirm).mockResolvedValue(true);
         vi.mocked(input).mockResolvedValueOnce('sk-proj-123');
         vi.mocked(input).mockResolvedValueOnce('');
-        await fs.writeFile(testState.envPath, `# API key for Anthropic
+        await fs.writeFile(testState.envExamplePath, `# API key for Anthropic
 ANTHROPIC_API_KEY=
 
 # API key for OpenAI
@@ -78,7 +118,7 @@ APIKEY=
 
 # Another comment
 OTHER=value`;
-        await fs.writeFile(testState.envPath, originalContent);
+        await fs.writeFile(testState.envExamplePath, originalContent);
         await configureEnvironmentVariables(testState.tempDir, false);
         const content = await fs.readFile(testState.envPath, 'utf-8');
         expect(content).toContain('# This is a comment');
@@ -90,7 +130,7 @@ OTHER=value`;
         const { input, confirm } = await import('@inquirer/prompts');
         vi.mocked(confirm).mockResolvedValue(true);
         vi.mocked(input).mockResolvedValueOnce('new-key');
-        await fs.writeFile(testState.envPath, `APIKEY=your_api_key_here
+        await fs.writeFile(testState.envExamplePath, `APIKEY=your_api_key_here
 EMPTY_KEY=`);
         const result = await configureEnvironmentVariables(testState.tempDir, false);
         expect(result).toBe(true);
@@ -103,21 +143,54 @@ EMPTY_KEY=`);
         const { input, confirm } = await import('@inquirer/prompts');
         vi.mocked(confirm).mockResolvedValue(true);
         vi.mocked(input).mockResolvedValueOnce('new-key');
-        await fs.writeFile(testState.envPath, `EXISTING_KEY=existing-value
+        await fs.writeFile(testState.envExamplePath, `EXISTING_KEY=existing-value
 
 EMPTY_KEY=`);
         await configureEnvironmentVariables(testState.tempDir, false);
         // Should only prompt for EMPTY_KEY, not EXISTING_KEY
         expect(vi.mocked(input)).toHaveBeenCalledTimes(1);
     });
+    it('should handle case where .env already exists (overwrite with copy)', async () => {
+        const { input, confirm } = await import('@inquirer/prompts');
+        vi.mocked(confirm).mockResolvedValue(true);
+        vi.mocked(input).mockResolvedValueOnce('new-configured-value');
+        // Create existing .env with old content
+        await fs.writeFile(testState.envPath, 'OLD_KEY=old-value');
+        // Create .env.example with new content
+        await fs.writeFile(testState.envExamplePath, 'NEW_KEY=');
+        const result = await configureEnvironmentVariables(testState.tempDir, false);
+        expect(result).toBe(true);
+        // .env should be overwritten with .env.example content and configured values
+        const envContent = await fs.readFile(testState.envPath, 'utf-8');
+        expect(envContent).toContain('NEW_KEY=new-configured-value');
+        expect(envContent).not.toContain('OLD_KEY');
+    });
     it('should return false if an error occurs during parsing', async () => {
-        // This test verifies error handling by checking behavior when file operations fail
-        // The try-catch in configureEnvironmentVariables should handle it gracefully
-        await fs.writeFile(testState.envPath, 'KEY=');
-        // Delete the file to cause parsing error
-        await fs.rm(testState.envPath);
+        const { confirm } = await import('@inquirer/prompts');
+        vi.mocked(confirm).mockResolvedValue(true);
+        await fs.writeFile(testState.envExamplePath, 'KEY=');
+        // Delete the .env.example file after access check but before parsing would happen
+        // We simulate this by deleting during the copy operation
+        const originalCopyFile = fs.copyFile;
+        vi.spyOn(fs, 'copyFile').mockImplementation(async () => {
+            throw new Error('Copy failed');
+        });
         const result = await configureEnvironmentVariables(testState.tempDir, false);
         // Should return false when error occurs
         expect(result).toBe(false);
+        // Restore original function
+        vi.mocked(fs.copyFile).mockImplementation(originalCopyFile);
+    });
+    it('should prompt for SECRET marker values with password input', async () => {
+        const { password, confirm } = await import('@inquirer/prompts');
+        vi.mocked(confirm).mockResolvedValue(true);
+        vi.mocked(password).mockResolvedValueOnce('my-secret-api-key');
+        await fs.writeFile(testState.envExamplePath, `# API Key
+ANTHROPIC_API_KEY=<SECRET>`);
+        const result = await configureEnvironmentVariables(testState.tempDir, false);
+        expect(result).toBe(true);
+        expect(vi.mocked(password)).toHaveBeenCalledTimes(1);
+        const envContent = await fs.readFile(testState.envPath, 'utf-8');
+        expect(envContent).toContain('ANTHROPIC_API_KEY=my-secret-api-key');
     });
 });

package/dist/services/messages.js

@@ -166,8 +166,8 @@ export const getProjectSuccessMessage = (folderName, installSuccess, envConfigur
     if (!envConfigured) {
         steps.push({
             step: 'Configure environment variables',
-            command: 'Edit .env file',
-            note: 'Add your Anthropic/OpenAI API keys'
+            command: 'cp .env.example .env',
+            note: 'Copy .env.example to .env and add your API keys'
         });
     }
     steps.push({
@@ -248,8 +248,8 @@ export const getWorkflowGenerateSuccessMessage = (workflowName, targetDir, files
         },
         {
             step: 'Configure environment',
-            command: 'Edit .env file',
-            note: 'Add your LLM provider credentials (ANTHROPIC_API_KEY or OPENAI_API_KEY)'
+            command: 'cp .env.example .env',
+            note: 'Copy .env.example to .env and add your LLM provider credentials'
         },
         {
             step: 'Test with example scenario',

package/dist/services/workflow_generator.spec.js

@@ -65,7 +65,6 @@ describe('Workflow Generator', () => {
                 'workflow.ts',
                 'steps.ts',
                 'README.md',
-                '.env',
                 'prompts/prompt@v1.prompt',
                 'scenarios/test_input.json'
             ];

package/dist/templates/agent_instructions/skills/output-error-zod-import/SKILL.md.template

@@ -139,7 +139,7 @@ grep -r 'from "zod"' src/
 ### 2. Build the project
 
 ```bash
-npm run build
+npm run output:workflow:build
 ```
 
 ### 3. Run the workflow

package/dist/templates/agent_instructions/skills/output-workflow-list/SKILL.md.template

@@ -108,7 +108,7 @@ cat src/workflows/simple/workflow.ts
 ### Workflow not showing
 - Check the file exports a valid workflow definition
 - Ensure the workflow file compiles without errors
-- Run `npm run build` to check for TypeScript errors
+- Run `npm run output:workflow:build` to check for TypeScript errors
 
 ## Related Commands
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@output.ai/cli",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "CLI for Output.ai workflow generation",
   "type": "module",
   "main": "dist/index.js",
@@ -35,7 +35,7 @@
     "handlebars": "4.7.8",
     "json-schema-library": "10.3.0",
     "ky": "1.12.0",
-    "validator": "13.15.20"
+    "validator": "13.15.22"
   },
   "devDependencies": {
     "@types/cli-progress": "3.11.6",

package/dist/templates/workflow/.env.template

@@ -1,7 +0,0 @@
-# API Keys for LLM providers
-OPENAI_API_KEY=your_openai_api_key_here
-ANTHROPIC_API_KEY=your_anthropic_api_key_here
-
-# Optional: Additional configuration
-# NODE_ENV=development
-# LOG_LEVEL=info