Install Script Generator

Workflow

Phase 1: Environment Exploration

# Run the environment explorer script
python3 scripts/env_explorer.py

• Operating system (Windows/Linux/macOS) and version
• CPU architecture (x86_64, ARM64, etc.)
• Package managers available (apt, yum, brew, choco, winget)
• Shell environment (bash, zsh, powershell, cmd)
• Existing dependencies and versions
• User permissions (admin/sudo availability)

Phase 2: Installation Planning

1. Identify dependencies - List all required packages/libraries
2. Check existing installations - Avoid reinstalling what exists
3. Order operations - Resolve dependency graph
4. Add verification steps - Each step must be verifiable
5. Plan rollback - Define cleanup on failure

python3 scripts/plan_generator.py --target "<software_name>" --env-file env_info.json

target: "<software_name>"
platform: "detected_os"
steps:
  - name: "Install dependency X"
    command: "..."
    verify: "command to verify success"
    rollback: "cleanup command if failed"
  - name: "Configure system"
    command: "..."
    verify: "..."

Phase 3: Execution

python3 scripts/executor.py --plan installation_plan.yaml

• Run each step sequentially
• Verify success after each step
• On failure: execute rollback, report error, stop
• Log all output for debugging
• Generate installation report

Phase 4: Documentation Generation

python3 scripts/doc_generator.py --target "<software_name>" --plan installation_plan.yaml

• Installation summary (what was installed, where)
• Quick start guide
• Common commands/usage examples
• Troubleshooting tips
• Uninstallation instructions

Output Files

env_info.json

installation_plan.yaml

install_report.md

USAGE_GUIDE.md

Platform-Specific Notes

Windows

• Prefer

  winget

  over

  choco

  when available
• Use PowerShell for script execution
• Handle UAC elevation requirements

Linux

• Detect distro family (Debian/RedHat/Arch)
• Use appropriate package manager
• Handle sudo requirements gracefully

macOS

• Use Homebrew as primary package manager
• Handle Apple Silicon vs Intel differences
• Respect Gatekeeper and notarization

Example Usage

1. Run env_explorer.py to detect system
2. Generate plan with Node.js as target
3. Execute plan (installs Node.js + npm)
4. Generate USAGE_GUIDE.md with npm commands

Error Handling

• All scripts exit with non-zero codes on failure
• Verification failures trigger rollback
• Detailed error messages include remediation hints
• Partial installations are cleaned up automatically