v3/helpers/README.md
The V3 Helper System provides cross-platform automation and development tools for claude-flow v3 users. These helpers enable automatic progress tracking, checkpointing, GitHub integration, and development workflow automation.
# Copy helpers to your claude-flow v3 project
cp -r v3/helpers/ your-project/.claude/helpers/
# Make scripts executable (Linux/Mac)
chmod +x your-project/.claude/helpers/*.sh
# Windows users: Use PowerShell scripts (.ps1)
# Linux/Mac
./.claude/helpers/claude-flow-v3.sh init
./.claude/helpers/claude-flow-v3.sh status
./.claude/helpers/claude-flow-v3.sh update domain 3
# Windows (PowerShell)
.\.claude\helpers\claude-flow-v3.ps1 init
.\.claude\helpers\claude-flow-v3.ps1 status
.\.claude\helpers\claude-flow-v3.ps1 update domain 3
claude-flow-v3.sh (Linux/Mac) / claude-flow-v3.ps1 (Windows)
progress-manager.sh/.ps1 - Update development metricsstatus-display.sh/.ps1 - Show current progressconfig-validator.sh/.ps1 - Validate environmentcheckpoint-manager.sh/.ps1 - Git-based checkpointingauto-commit.sh/.ps1 - Automated commit systemsession-manager.sh/.ps1 - Development session trackinggithub-integration.sh/.ps1 - GitHub workflow automationpr-management.sh/.ps1 - Pull request automationissue-tracker.sh/.ps1 - Issue management# Bash-based helpers with full ANSI color support
./helpers/claude-flow-v3.sh status
./helpers/checkpoint-manager.sh auto-checkpoint "Feature complete"
# PowerShell-based helpers with Windows Terminal integration
.\helpers\claude-flow-v3.ps1 status
.\helpers\checkpoint-manager.ps1 auto-checkpoint "Feature complete"
{
"helpers": {
"directory": ".claude/helpers",
"enabled": true,
"platform": "auto-detect",
"scripts": {
"master": ".claude/helpers/claude-flow-v3",
"progressManager": ".claude/helpers/progress-manager",
"checkpointManager": ".claude/helpers/checkpoint-manager",
"configValidator": ".claude/helpers/config-validator"
}
},
"v3Configuration": {
"domains": {
"total": 5,
"names": ["task-management", "session-management", "health-monitoring", "lifecycle-management", "event-coordination"],
"sourceDir": "src/domains"
},
"swarm": {
"totalAgents": 15,
"topology": "hierarchical-mesh",
"coordination": "queen-led"
},
"performance": {
"flashAttentionTarget": "2.49x-7.47x",
"memoryReductionTarget": "50-75%"
}
},
"hooks": {
"PostToolUse": [
{
"matcher": "Edit|Write|MultiEdit",
"hooks": [
{
"type": "command",
"command": ".claude/helpers/checkpoint-manager auto-checkpoint \"File edit: $TOOL_INPUT_file_path\""
}
]
}
]
}
}
.claude/helpers/custom/custom-helper-name.sh/.ps1{
"hooks": {
"PreToolUse": [
{
"matcher": "Task",
"hooks": [
{
"type": "command",
"command": ".claude/helpers/custom/pre-task-validation.sh \"$TOOL_INPUT_prompt\""
}
]
}
]
}
}
# Add custom metrics
./helpers/progress-manager.sh add-metric "custom-metric" 75
./helpers/progress-manager.sh set-target "custom-target" "100%"
# Add project-specific metrics
./helpers/progress-manager.sh define-metric \
--name "api-endpoints" \
--total 20 \
--current 12 \
--target "100%"
# GitHub Actions example
name: Claude Flow V3 Progress
on: [push]
jobs:
update-progress:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Update V3 Progress
run: |
./.claude/helpers/claude-flow-v3.sh update-from-ci
./.claude/helpers/checkpoint-manager.sh ci-checkpoint "Automated progress update"
{
"tasks": [
{
"label": "V3 Status",
"type": "shell",
"command": "./.claude/helpers/claude-flow-v3.sh status",
"group": "build",
"presentation": {
"echo": true,
"reveal": "always",
"focus": false,
"panel": "shared"
}
}
]
}
# Fix permission issues
find .claude/helpers -name "*.sh" -exec chmod +x {} \;
# Allow local script execution
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
# Add helpers to PATH (optional)
export PATH="$PATH:$(pwd)/.claude/helpers"
Claude Flow V3 Helper System - Enabling cross-platform development automation