propelsdlc-windsurf-stub

Windsurf configuration stub for PropelSDLC projects by KANINI Software Solutions. This package provides a complete setup for AI-assisted development with Windsurf, including workflows, agents, skills, and project configuration.

PROPRIETARY SOFTWARE - This software is the property of KANINI Software Solutions. See LICENSE file for terms and conditions.

Installation

# Global install
npm install -g propelsdlc-windsurf-stub

# Or use directly with npx (no installation needed)
npx propelsdlc-windsurf-stub

Usage

Navigate to your project root directory and run:

propelsdlc-windsurf-init

Or if using npx:

npx propelsdlc-windsurf-stub

The installer will copy configuration files to your current directory.

This will install the following to your project root:

• .windsurf/ - Windsurf workflows, agents, and configuration
• .propel/ - PropelSDLC templates, rules, prompts, and orchestrators
• .env-example - Environment variable template
• mcp_config-example.json - MCP (Model Context Protocol) server configuration template

Note: Existing files and folders will be skipped to preserve your customizations.

What Gets Installed

.windsurf/ Structure

• workflows/ - Reusable AI workflows for various development tasks
• skills/ - Domain-specific knowledge and coding standards
• rules/ - Validation and enforcement rules
• AGENTS.md - Agent configuration
• hooks.json - Windsurf hooks configuration

.propel/ Structure

• prompts/ - Workflow prompts for change management and analysis
• templates/ - Document templates for specs, plans, and artifacts
• rules/ - Custom validation and enforcement rules
• orchestrators/ - Workflow orchestration definitions
• learnings/ - Captured patterns and findings
• hooks/ - PropelIQ hooks
• instructions.md - Core workflow instructions
• id-scheme-registry.md - ID scheme registry for artifacts
• project-config.json - Project configuration
• requirements.txt - Python dependencies for skills

.env-example

• Environment variable template for project configuration

mcp_config-example.json

• Model Context Protocol (MCP) server configuration template
• Rename to mcp_config.json and configure for your Windsurf installation

Post-Installation Steps

1. Configure Environment Variables

   # Rename example file
   cp .env-example .env
      
   # Add your API keys (e.g., CONTEXT7_API_KEY=your-key-here)
   # Edit .env with your project-specific values

   IMPORTANT - Add .env to .gitignore:

   echo .env >> .gitignore

   This prevents exposing sensitive API keys and credentials to version control.

   Note: The Context7 API key is read from the .env file, not directly from mcp_config.json

   Get your Context7 API key at: https://context7.ai

2. Configure MCP Servers

   Rename and configure the MCP template:

   # Rename the example file
   mv mcp_config-example.json mcp_config.json
   # Or copy to Windsurf config location (Windows):
   # %APPDATA%\Windsurf\User\globalStorage\mcp_config.json

   Configure MCP servers as needed:

   • propel-iq - PropelSDLC template and workflow management
   • context7 - Semantic code search (API key read from .env file)
   • azure-mcp - Azure resource management
   • Configure server-specific settings (endpoints, paths, etc.)
   • Restart Windsurf after configuration changes

3. Customize Windsurf Workflows

   • Review .windsurf/workflows/ for available workflows
   • Review .windsurf/AGENTS.md for agent configuration
   • Customize workflow descriptions and behaviors as needed

4. Configure PropelIQ

   • Update .propel/project-config.json with your project details
   • Review .propel/instructions.md for workflow guidance

5. Install Python Dependencies (if using skills)

   pip install -r .propel/requirements.txt

Features

AI-Assisted Development

• 40+ pre-configured workflows for common development tasks
• Specialized agents for different tasks
• Comprehensive coding standards and guidelines
• PropelIQ workflow integration

Change Management

• Structured change request workflows
• Impact analysis automation
• Traceability enforcement

Quality Assurance

• Test plan generation
• Code review automation
• Edge case analysis

Documentation

• Automatic spec generation
• UML and PlantUML support
• Figma integration for design specs

Updating Configuration

The installer skips existing files to preserve your customizations. To update specific components:

Option 1: Selective Update

1. Backup your customizations

   cp -r .windsurf .windsurf.backup
   cp -r .propel .propel.backup

2. Remove what you want to update

   # Example: Update only .windsurf folder
   rm -rf .windsurf

3. Re-run installer from your project root

   propeliq-windsurf-init

4. Merge customizations from your backup if needed

Option 2: Fresh Install

Remove all installed components and reinstall:

rm -rf .windsurf .propel .env-example
propeliq-windsurf-init

Troubleshooting

Files Already Exist

The installer automatically skips existing files and folders to preserve your customizations. If you want to reinstall specific items, remove or rename them first.

Wrong Installation Directory

Always run propeliq-windsurf-init from your project root directory. The installer copies files to the current working directory (where you execute the command).

Permission Errors

Ensure you have write permissions in the target directory.

Missing Dependencies

Some features require Python packages. Install them with:

pip install -r .propel/requirements.txt

MCP Configuration

If your project needs MCP server integration, refer to mcp_config-example.json in your project root and configure according to your Windsurf setup.

Environment Variables & Security

Always add .env to .gitignore to prevent exposing API keys:

echo .env >> .gitignore

Rename .env-example to .env and add your API keys. The Context7 API key is read from .env, not from mcp_config.json.

Get your Context7 API key at: https://context7.ai

Customization

All installed files are meant to be customized for your project. The installer creates a baseline configuration that you should adapt to your specific needs.

Key files to customize:

• .windsurf/workflows/*.md - Windsurf workflow definitions
• .windsurf/AGENTS.md - Agent configuration
• .propel/project-config.json - Project-specific settings
• .propel/instructions.md - Workflow preferences

Support

For licensing, support, or questions:

• Email: [email protected]
• Website: https://www.kanini.com/propeliq
• Documentation: Review installed files in .windsurf/ and .propel/ folders

License

Proprietary - Copyright (c) 2026 KANINI Software Solutions. All rights reserved.

This software is the property of KANINI Software Solutions and is protected by copyright law. Unauthorized copying, distribution, modification, or use of this software is strictly prohibited without prior written permission from KANINI Software Solutions.

See LICENSE file for complete terms and conditions.