# propelsdlc-claudecode-stub

Claude Code configuration stub for PropelSDLC projects by KANINI Software Solutions. This package provides a complete setup for AI-assisted development with Claude Code, including commands, prompts, skills, and project configuration.

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

## Installation

### Prerequisites

- Node.js >= 14.0.0
- npm (comes with Node.js)

### Install Package

```bash
npm install -g propelsdlc-claudecode-stub
```

Or as a dev dependency in your project:

```bash
npm install --save-dev propelsdlc-claudecode-stub
```

## Usage

Navigate to your project root directory and run:

```bash
npx propelsdlc-claudecode-stub
```

Or if installed globally:

```bash
propelsdlc-claude-init
```

The installer will copy configuration files to your current directory (where you run the command).

This will install the following to your project root:

- `.claude/` - Claude Code commands and configuration
- `.propel/` - PropelSDLC templates, rules, prompts, and orchestrators
- `.mcp.json` - MCP (Model Context Protocol) server configuration template

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

## What Gets Installed

### `.claude/` Structure
- **commands/** - Reusable AI commands for various development tasks
- Claude Code-specific configuration files

### `.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/** - PropelSDLC 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

### `.mcp.json`
- MCP (Model Context Protocol) server configuration template
- Configure server endpoints and settings
- Common MCP servers: propel-iq, context7, azure-mcp

## Post-Installation Steps

1. **Configure Context7 API Key**
   - Open Claude Code settings (Ctrl+,)
   - Search for "context7"
   - Add your Context7 API key to `.claude/settings.json`:
     ```json
     {
       "context7.apiKey": "your-api-key-here"
     }
     ```
   
   **Note**: For Claude Code, the Context7 API key is read from `.claude/settings.json`, not from `.env` or `.mcp.json`
   
   Get your Context7 API key at: https://context7.ai

2. **Configure MCP Servers**
   - Open `.mcp.json` in your project root
   - Update the PropelIQ MCP server URL:
     ```json
     {
       "mcpServers": {
         "propel-iq": {
           "type": "http",
           "url": "<propel-mcp-url>/mcp"
         }
       }
     }
     ```
   - Review and configure enabled servers
   - Common MCP servers for PropelSDLC projects:
     - `propel-iq` - PropelSDLC template and workflow management
     - `context7` - Semantic code search
     - `azure-mcp` - Azure resource management
   - Restart Claude Code after configuration changes

3. **Customize Claude Code Commands**
   - Review `.claude/commands/` for available commands
   - Customize command descriptions and behaviors as needed

4. **Update Project Configuration**
   - Update `.propel/project-config.json` with your project details
   - Review `.propel/instructions.md` for workflow guidance

4. **Install Python Dependencies (if using skills)**
   ```bash
   pip install -r .propel/requirements.txt
   ```

## Features

### AI-Assisted Development
- 40+ pre-configured commands for common development tasks
- Comprehensive coding standards and guidelines
- PropelSDLC 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**
   ```bash
   cp -r .claude .claude.backup
   cp -r .propel .propel.backup
   ```

2. **Remove what you want to update**
   ```bash
   # Example: Update only .claude folder
   rm -rf .claude
   ```

3. **Re-run installer from your project root**
   ```bash
   propelsdlc-claude-init
   ```

4. **Merge customizations** from your backup if needed

### Option 2: Fresh Install

Remove all installed components and reinstall:
```bash
rm -rf .claude .propel .env-example
propelsdlc-claude-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 `propelsdlc-claude-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:
```bash
pip install -r .propel/requirements.txt
```

### MCP Configuration
Create a `.mcp.json` file in your project root for MCP server integration. Refer to Claude Code and MCP documentation for configuration details.

### Environment Variables & Security
**Always add `.env` to `.gitignore`** to prevent exposing API keys:
```bash
echo .env >> .gitignore
```
Rename `.env-example` to `.env` and add your API keys. For Claude Code, the Context7 API key is configured in `settings.json`, not in `.env` or `.mcp.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:
- `.claude/commands/*.md` - Claude Code command definitions
- `.propel/project-config.json` - Project-specific settings
- `.propel/instructions.md` - Workflow preferences

## Support

For licensing, support, or questions:
- Email: support@kanini.com
- Website: https://www.kanini.com/propelsdlc
- Documentation: Review installed files in `.claude/` 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.
