/install
Validate your AgileFlow installation after running npx agileflow setup. Reports what's installed correctly and what needs attention.
Quick Start
/agileflow:installThis validates all aspects of your installation and reports health status.
Parameters
No arguments required. The command validates the entire installation automatically.
What Gets Validated
The installation validator checks:
- Directory Structure - Core folders exist (.agileflow/, .claude/, docs/)
- Scripts - Required scripts exist and are executable
- Hook Configuration - Hooks configured in .claude/settings.json
- JSON File Integrity - All JSON files are valid
- Slash Commands - Commands are installed
- Version Information - Installed vs. latest version
Validation Categories
Directory Structure
Required directories:
.agileflow/- Core installation.agileflow/agents/- Agent definitions.agileflow/commands/- Command definitions.agileflow/scripts/- Utility scripts.claude/- Claude Code integration.claude/commands/agileflow/- Slash commandsdocs/09-agents/- Status tracking
Optional directories:
docs/00-meta/- Metadatadocs/03-decisions/- Architecture Decision Recordsdocs/04-architecture/- Architecture docsdocs/05-epics/- Epic tracking
Scripts
Checks for required scripts:
agileflow-welcome.js- Welcome messagearchive-completed-stories.sh- Story archivalprecompact-context.sh- Context preservation
Optional scripts:
agileflow-statusline.sh- Custom status lineobtain-context.js- Context loadersession-manager.js- Session management
Hook Configuration
Validates hooks in .claude/settings.json:
- SessionStart - Runs on session start (welcome, archival)
- PreCompact - Runs before context compaction
- PreToolUse - Runs before tool execution (damage control)
JSON Files
Validates integrity of:
docs/00-meta/agileflow-metadata.jsondocs/09-agents/status.json.claude/settings.jsondocs/09-agents/session-state.json
Version Information
Reports:
- Installed version
- Latest available version
- Update availability
Output Format
Successful Installation
š AgileFlow Installation Validation
=====================================
š Directory Structure
----------------------
ā
.agileflow
ā
.agileflow/agents
ā
.agileflow/commands
ā
.agileflow/scripts
ā
.claude
ā
.claude/commands/agileflow
ā
docs/09-agents
ā
docs/00-meta
ā
docs/03-decisions
ā
docs/04-architecture
š Script Installation
----------------------
ā
agileflow-welcome.js
ā
archive-completed-stories.sh
ā
precompact-context.sh
ā
agileflow-statusline.sh
šŖ Hook Configuration
---------------------
ā
.claude/settings.json is valid JSON
ā
SessionStart hooks: 2 configured
ā
PreCompact hooks: 1 configured
ā
PreToolUse hooks: 3 configured (damage control)
š JSON File Integrity
----------------------
ā
docs/00-meta/agileflow-metadata.json (2KB)
ā
docs/09-agents/status.json (15KB)
ā
.claude/settings.json (8KB)
ā” Slash Commands
-----------------
ā
79 slash commands installed
š¦ Version Information
----------------------
ā
Installed version: v2.94.1
ā¹ļø Latest available: v2.94.1
š Installation Summary
=======================
ā
Installation validated successfully!
Next steps:
⢠Run /agileflow:board to see your kanban board
⢠Run /agileflow:story to create your first story
⢠Run /agileflow:help for all available commands
Installation with Issues
š AgileFlow Installation Validation
=====================================
š Directory Structure
----------------------
ā
.agileflow
ā .agileflow/agents - MISSING (REQUIRED)
ā
.agileflow/commands
ā
.claude
š Script Installation
----------------------
ā
agileflow-welcome.js
ā ļø archive-completed-stories.sh - exists but not executable
Fix: chmod +x .agileflow/scripts/archive-completed-stories.sh
ā
precompact-context.sh
šŖ Hook Configuration
---------------------
ā
.claude/settings.json is valid JSON
ā ļø SessionStart hooks: not configured
Run: /agileflow:configure to enable welcome display
š Installation Summary
=======================
ā Installation has 1 error(s) and 2 warning(s).
Required actions:
1. Re-run setup: npx agileflow setup --force
2. Fix script permissions: chmod +x .agileflow/scripts/archive-completed-stories.sh
3. Run /agileflow:configure to enable hooks
Status Indicators
| Indicator | Meaning |
|---|---|
| ā | Validation passed - item is healthy |
| ā | Validation failed - item is missing or broken |
| ā ļø | Warning - item exists but needs attention |
| ā¹ļø | Informational - optional item not found |
Fixing Installation Issues
Missing Required Directories
# Re-run setup to restore missing directories
npx agileflow setup --forceNon-executable Scripts
# Make scripts executable
chmod +x .agileflow/scripts/*.shInvalid JSON Files
Files with invalid JSON need manual repair:
- Check syntax errors in the file
- Use JSON validator to find issues
- Fix manually or re-run setup
Missing Hooks
Configure hooks to enable features:
/agileflow:configureThis opens the configuration interface to set up hooks.
Common Issues and Solutions
| Issue | Cause | Solution |
|---|---|---|
.agileflow missing | Incomplete setup | npx agileflow setup --force |
| Scripts not executable | Permission issue | chmod +x .agileflow/scripts/*.sh |
| Invalid JSON | Corrupted file | Re-run setup or manual fix |
| No hooks configured | Setup skipped hooks | /agileflow:configure |
| Slash commands missing | Installation failure | npx agileflow setup --force |
| Version mismatch | Update available | npx agileflow update |
Running After Installation
Once installation is validated:
- Create your first story:
/agileflow:story - View kanban board:
/agileflow:board - Configure features:
/agileflow:configure - Get help:
/agileflow:help
When to Run
Run this command:
- After setup: Verify installation completed successfully
- Troubleshooting: Check what's broken
- Regular maintenance: Part of
/agileflow:maintain
Related Commands
/maintain- Periodic maintenance checks/diagnose- Full system health diagnostics/configure- Configure AgileFlow features/help- Display AgileFlow overview
On This Page
/installQuick StartParametersWhat Gets ValidatedValidation CategoriesDirectory StructureScriptsHook ConfigurationJSON FilesVersion InformationOutput FormatSuccessful InstallationInstallation with IssuesStatus IndicatorsFixing Installation IssuesMissing Required DirectoriesNon-executable ScriptsInvalid JSON FilesMissing HooksCommon Issues and SolutionsRunning After InstallationWhen to RunRelated Commands