@iservu-inc/adf-cli 0.1.4 → 0.1.6

package/CHANGELOG.md

@@ -0,0 +1,138 @@
+# Changelog
+
+All notable changes to `@iservu-inc/adf-cli` will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.6] - 2025-10-02
+
+### Fixed
+- Fixed step numbering in init success message
+  - Steps now number correctly (1, 2, 3) when deployment is completed
+  - Steps number correctly (1, 2, 3, 4) when deployment is skipped
+  - Eliminated confusing jump from step 2 to step 4
+
+### Documentation
+- Updated README.md with comprehensive usage examples
+- Added context.json structure documentation
+- Added documentation about local file paths feature
+- Added detailed "What Gets Installed" section with complete directory structure
+
+## [0.1.5] - 2025-10-02
+
+### Added
+- New question in init workflow: "Do you have local documentation files to include?"
+  - Allows users to specify local file paths (e.g., `./docs/`, `./README.md`)
+  - Added `documentationFiles` array to context.json structure
+  - Complements existing `documentationUrls` field
+
+### Changed
+- Init workflow now collects both remote URLs and local file paths for documentation
+- Enhanced context.json to track local documentation references
+
+## [0.1.4] - 2025-10-02
+
+### Fixed
+- Fixed context.json to use actual CLI version instead of hardcoded "0.1.01"
+  - Now dynamically reads version from package.json
+  - context.json correctly reflects which version of CLI was used to initialize
+
+### Changed
+- Updated `project-detector.js` to import package.json for version tracking
+
+## [0.1.3] - 2025-10-02
+
+### Fixed
+- Fixed critical `ReferenceError` in init command
+  - `deployNow` variable was referenced outside its scope
+  - Caused initialization to crash after displaying success message
+  - Properly scoped variable to fix error
+
+### Changed
+- Improved variable scoping in init.js for better reliability
+
+## [0.1.2] - 2025-10-02
+
+### Documentation
+- Updated README.md with correct package name throughout
+- Fixed all installation command references to use `@iservu-inc/adf-cli`
+- Updated 8 instances of package name in documentation
+
+## [0.1.1] - 2025-10-02
+
+### Fixed
+- Fixed update command to check correct package name on npm registry
+  - Was checking `@iservu/adf-cli` instead of `@iservu-inc/adf-cli`
+  - Updated npm registry URLs in update.js
+
+## [0.1.0] - 2025-10-02
+
+### Added
+- Initial release of AgentDevFramework CLI tool
+- Three workflow levels:
+  - Level 1: Rapid Development (PRP) - 5-15 min planning
+  - Level 2: Specification-Driven (Balanced) - 30-60 min planning
+  - Level 3: BMAD Comprehensive - 1-2+ hour planning
+- Interactive `adf init` command with intelligent workflow recommendations
+- Support for multiple development tools:
+  - Windsurf, Cursor, VS Code, VS Code Insider
+  - Kiro, Trae, Claude Code, Gemini CLI, Codex CLI
+- `adf deploy` command for deploying to development tools
+- `adf update` command for checking and installing CLI updates
+- Automatic project type detection (new vs existing)
+- Documentation URL collection during initialization
+- Agent deployment based on workflow level:
+  - Rapid: dev, qa
+  - Balanced: analyst, pm, dev, qa
+  - Comprehensive: analyst, pm, architect, sm, dev, qa
+- Template copying and configuration generation
+- Environment template creation (.env.template)
+- Framework memory and constitution files
+- MCP configuration support
+
+### Commands
+- `adf init [--rapid|--balanced|--comprehensive] [--tool <tool>]` - Initialize framework
+- `adf deploy [tool] [--list]` - Deploy to development tool
+- `adf update [--check]` - Update CLI to latest version
+- `adf --version` - Show CLI version
+- `adf --help` - Show help information
+
+### Project Structure
+Creates isolated `.adf/` directory with:
+- context.json - Workflow configuration
+- scripts/ - Helper scripts
+- shared/ - Templates, agents, MCP configs, memory files
+
+Deploys to `.framework/` directory with:
+- agents/ - Deployed agent definition files
+
+Creates tool-specific configuration files:
+- .windsurfrules, .cursorrules, .vscode/settings.json, etc.
+
+## Package Naming History
+
+### Scope Change
+- Original name: `@iservu/adf-cli` (failed to publish - scope mismatch)
+- Updated to: `@iservu-inc/adf-cli` (matches npm username `iservu-inc`)
+- First successful publish: v0.1.0
+
+---
+
+## Links
+
+- [npm Package](https://www.npmjs.com/package/@iservu-inc/adf-cli)
+- [GitHub Repository](https://github.com/iServU/adf-cli)
+- [Issue Tracker](https://github.com/iServU/adf-cli/issues)
+
+## Release Notes Format
+
+### Types of Changes
+- **Added** for new features
+- **Changed** for changes in existing functionality
+- **Deprecated** for soon-to-be removed features
+- **Removed** for now removed features
+- **Fixed** for any bug fixes
+- **Security** for vulnerability fixes

package/README.md

@@ -26,6 +26,13 @@ Initialize AgentDevFramework in your current project:
 adf init
 ```
 
+The interactive init process will:
+1. Detect if this is a new or existing project
+2. Ask questions to recommend the best workflow level
+3. Optionally collect documentation URLs (e.g., API docs, design docs)
+4. Optionally collect local documentation file paths (e.g., `./docs/`, `./README.md`)
+5. Offer to deploy to your preferred development tool
+
 #### Workflow Selection Options
 
 Skip interactive questions and specify workflow directly:
@@ -109,22 +116,48 @@ When you run `adf init`, the following structure is created in your project:
 ```
 your-project/
 ├── .adf/                    # Framework files (isolated)
-│   ├── scripts/
-│   │   ├── prp.ps1
-│   │   ├── spec.ps1
-│   │   └── ...
-│   ├── shared/
-│   │   ├── bmad/
-│   │   ├── templates/
-│   │   ├── spec-kit/
-│   │   └── prp/
-│   └── context.json         # Your workflow configuration
+│   ├── context.json         # Your workflow configuration
+│   ├── scripts/             # Helper scripts
+│   └── shared/              # Templates, agents, and resources
+│       ├── agents/          # Agent definition files
+│       ├── templates/       # PRP, BMAD, Spec-Kit templates
+│       ├── mcp/             # MCP configurations
+│       └── memory/          # Framework memory/constitution
+├── .framework/              # Deployment directory
+│   └── agents/              # Deployed agent files for your tool
 ├── .env.template            # Environment variables template
+├── .[tool]rules             # Tool-specific config (e.g., .windsurfrules)
 └── [your existing files]    # Completely untouched!
 ```
 
 **Important:** Your `package.json` and existing project files remain completely untouched.
 
+### context.json Structure
+
+The `.adf/context.json` file contains your workflow configuration:
+
+```json
+{
+  "version": "0.1.6",
+  "workflow": "rapid",
+  "projectType": "existing",
+  "documentationUrls": [
+    "https://api.example.com/docs"
+  ],
+  "documentationFiles": [
+    "./docs/",
+    "./README.md"
+  ],
+  "createdAt": "2025-10-02T...",
+  "agents": ["dev", "qa"],
+  "templates": {
+    "prp": ["prp_story.md", "prp_task.md"],
+    "bmad": false,
+    "specKit": false
+  }
+}
+```
+
 ## Workflow Levels
 
 ### Level 1: Rapid Development (PRP)
@@ -211,7 +244,13 @@ When we release updates to the framework:
 
 ## Version History
 
-- `0.1.01` - Initial release
+See [CHANGELOG.md](./CHANGELOG.md) for detailed version history.
+
+**Latest:** v0.1.6
+- Fixed step numbering in init success message
+- Added local documentation files collection
+- Dynamic version tracking in context.json
+- Improved error handling
 
 ## Troubleshooting
 

package/lib/commands/init.js

@@ -81,6 +81,29 @@ async function init(options) {
     documentationUrls = urls;
   }
 
+  // Gather local documentation files (optional)
+  const { hasLocalDocs } = await inquirer.prompt([
+    {
+      type: 'confirm',
+      name: 'hasLocalDocs',
+      message: 'Do you have local documentation files to include? (use "." as the project root folder & add like so "./docs/")',
+      default: false
+    }
+  ]);
+
+  let documentationFiles = [];
+  if (hasLocalDocs) {
+    const { files } = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'files',
+        message: 'Enter local documentation paths (comma-separated, e.g., ./docs/, ./README.md):',
+        filter: (input) => input.split(',').map(file => file.trim()).filter(Boolean)
+      }
+    ]);
+    documentationFiles = files;
+  }
+
   // Copy framework templates
   const copySpinner = ora('Copying framework files...').start();
   await copyTemplates(cwd);
@@ -91,6 +114,7 @@ async function init(options) {
     workflow,
     projectType: projectType.type,
     documentationUrls,
+    documentationFiles,
     timestamp: new Date().toISOString()
   });
 
@@ -159,8 +183,10 @@ async function init(options) {
   console.log(chalk.gray('  2. Copy .env.template to .env and configure'));
   if (!deployNow) {
     console.log(chalk.gray('  3. Run "adf deploy <tool>" to deploy to your editor'));
+    console.log(chalk.gray('  4. Check documentation: .adf/shared/templates/\n'));
+  } else {
+    console.log(chalk.gray('  3. Check documentation: .adf/shared/templates/\n'));
   }
-  console.log(chalk.gray('  4. Check documentation: .adf/shared/templates/\n'));
 
   console.log(chalk.blue(`Workflow: ${workflow === 'rapid' ? 'Level 1 (Rapid)' : workflow === 'balanced' ? 'Level 2 (Balanced)' : 'Level 3 (Comprehensive)'}`));
   console.log(chalk.gray('Run "adf deploy --list" to see available tools\n'));

package/lib/utils/project-detector.js

@@ -176,6 +176,7 @@ function generateContextFile(data) {
     workflow: data.workflow,
     projectType: data.projectType,
     documentationUrls: data.documentationUrls || [],
+    documentationFiles: data.documentationFiles || [],
     createdAt: data.timestamp,
     agents: getAgentsForWorkflow(data.workflow),
     templates: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iservu-inc/adf-cli",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "CLI tool for AgentDevFramework - AI-assisted development framework",
   "main": "index.js",
   "bin": {

package/test-scenarios.sh

@@ -0,0 +1,134 @@
+#!/bin/bash
+
+# Comprehensive Test Script for @iservu-inc/adf-cli
+# Tests all major scenarios and validates outputs
+
+set -e  # Exit on error
+
+echo "=================================="
+echo "ADF CLI Comprehensive Test Suite"
+echo "=================================="
+echo ""
+
+# Colors
+GREEN='\033[0;32m'
+RED='\033[0;31m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+TEST_BASE_DIR="D:/Documents/GitHub/adf-cli-tests"
+PASS_COUNT=0
+FAIL_COUNT=0
+
+# Cleanup function
+cleanup() {
+    rm -rf "$TEST_BASE_DIR"
+    mkdir -p "$TEST_BASE_DIR"
+}
+
+# Test result function
+test_result() {
+    if [ $1 -eq 0 ]; then
+        echo -e "${GREEN}✓ PASS${NC}: $2"
+        ((PASS_COUNT++))
+    else
+        echo -e "${RED}✗ FAIL${NC}: $2"
+        ((FAIL_COUNT++))
+    fi
+}
+
+# Setup
+cleanup
+
+echo "=== Test 1: Rapid Workflow with Tool ===="
+cd "$TEST_BASE_DIR"
+mkdir test-rapid && cd test-rapid
+echo "# Test" > README.md
+printf "n\nn\n" | adf init --rapid --tool windsurf > /dev/null 2>&1
+test_result $? "Rapid workflow initialization"
+[ -f ".adf/context.json" ] && test_result 0 "context.json created" || test_result 1 "context.json missing"
+[ -f ".env.template" ] && test_result 0 ".env.template created" || test_result 1 ".env.template missing"
+[ -f ".windsurfrules" ] && test_result 0 ".windsurfrules created" || test_result 1 ".windsurfrules missing"
+[ -f ".framework/agents/dev.md" ] && test_result 0 "dev agent deployed" || test_result 1 "dev agent missing"
+[ -f ".framework/agents/qa.md" ] && test_result 0 "qa agent deployed" || test_result 1 "qa agent missing"
+WORKFLOW=$(cat .adf/context.json | grep -o '"workflow": "[^"]*"' | cut -d'"' -f4)
+[ "$WORKFLOW" = "rapid" ] && test_result 0 "Workflow is rapid" || test_result 1 "Workflow incorrect: $WORKFLOW"
+echo ""
+
+echo "=== Test 2: Balanced Workflow ===="
+cd "$TEST_BASE_DIR"
+mkdir test-balanced && cd test-balanced
+echo "# Test" > README.md
+printf "n\nn\n" | adf init --balanced --tool cursor > /dev/null 2>&1
+test_result $? "Balanced workflow initialization"
+[ -f ".cursorrules" ] && test_result 0 ".cursorrules created" || test_result 1 ".cursorrules missing"
+[ -f ".framework/agents/analyst.md" ] && test_result 0 "analyst agent deployed" || test_result 1 "analyst agent missing"
+[ -f ".framework/agents/pm.md" ] && test_result 0 "pm agent deployed" || test_result 1 "pm agent missing"
+WORKFLOW=$(cat .adf/context.json | grep -o '"workflow": "[^"]*"' | cut -d'"' -f4)
+[ "$WORKFLOW" = "balanced" ] && test_result 0 "Workflow is balanced" || test_result 1 "Workflow incorrect: $WORKFLOW"
+echo ""
+
+echo "=== Test 3: Comprehensive Workflow ===="
+cd "$TEST_BASE_DIR"
+mkdir test-comprehensive && cd test-comprehensive
+echo "# Test" > README.md
+printf "n\nn\n" | adf init --comprehensive --tool vscode > /dev/null 2>&1
+test_result $? "Comprehensive workflow initialization"
+[ -d ".vscode" ] && test_result 0 ".vscode directory created" || test_result 1 ".vscode missing"
+[ -f ".framework/agents/architect.md" ] && test_result 0 "architect agent deployed" || test_result 1 "architect agent missing"
+[ -f ".framework/agents/sm.md" ] && test_result 0 "sm agent deployed" || test_result 1 "sm agent missing"
+WORKFLOW=$(cat .adf/context.json | grep -o '"workflow": "[^"]*"' | cut -d'"' -f4)
+[ "$WORKFLOW" = "comprehensive" ] && test_result 0 "Workflow is comprehensive" || test_result 1 "Workflow incorrect: $WORKFLOW"
+echo ""
+
+echo "=== Test 4: Deploy Command ===="
+cd "$TEST_BASE_DIR/test-rapid"
+adf deploy cursor > /dev/null 2>&1
+test_result $? "Deploy to cursor"
+[ -f ".cursorrules" ] && test_result 0 "cursor config created" || test_result 1 "cursor config missing"
+echo ""
+
+echo "=== Test 5: Deploy List ===="
+OUTPUT=$(adf deploy --list 2>&1)
+echo "$OUTPUT" | grep -q "windsurf" && test_result 0 "windsurf in deploy list" || test_result 1 "windsurf not found"
+echo "$OUTPUT" | grep -q "cursor" && test_result 0 "cursor in deploy list" || test_result 1 "cursor not found"
+echo "$OUTPUT" | grep -q "claude-code" && test_result 0 "claude-code in deploy list" || test_result 1 "claude-code not found"
+echo ""
+
+echo "=== Test 6: Version Check ===="
+VERSION=$(adf --version 2>&1)
+test_result $? "Version command works"
+echo "Current version: $VERSION"
+echo ""
+
+echo "=== Test 7: Update Check ===="
+adf update --check > /dev/null 2>&1
+test_result $? "Update check command"
+echo ""
+
+echo "=== Test 8: Context.json Structure ===="
+cd "$TEST_BASE_DIR/test-rapid"
+cat .adf/context.json | grep -q '"version"' && test_result 0 "version field exists" || test_result 1 "version field missing"
+cat .adf/context.json | grep -q '"workflow"' && test_result 0 "workflow field exists" || test_result 1 "workflow field missing"
+cat .adf/context.json | grep -q '"documentationUrls"' && test_result 0 "documentationUrls field exists" || test_result 1 "documentationUrls field missing"
+cat .adf/context.json | grep -q '"documentationFiles"' && test_result 0 "documentationFiles field exists" || test_result 1 "documentationFiles field missing"
+cat .adf/context.json | grep -q '"agents"' && test_result 0 "agents field exists" || test_result 1 "agents field missing"
+echo ""
+
+echo "==================================="
+echo "Test Summary"
+echo "==================================="
+echo -e "${GREEN}Passed:${NC} $PASS_COUNT"
+echo -e "${RED}Failed:${NC} $FAIL_COUNT"
+echo ""
+
+# Cleanup
+cleanup
+
+if [ $FAIL_COUNT -eq 0 ]; then
+    echo -e "${GREEN}All tests passed!${NC}"
+    exit 0
+else
+    echo -e "${RED}Some tests failed${NC}"
+    exit 1
+fi