f5-framework-cli
Advanced tools
+17
-11
| { | ||
| "name": "f5-framework-cli", | ||
| "version": "1.1.0", | ||
| "description": "F5 Framework CLI v1.1.0 - Enterprise Spec-Driven Development Toolkit", | ||
| "version": "1.1.1", | ||
| "description": "F5 Framework - Enterprise Spec-Driven Development Toolkit with BA/SRS capabilities", | ||
| "bin": { | ||
@@ -44,17 +44,23 @@ "f5": "./bin/f5.js" | ||
| "keywords": [ | ||
| "f5", | ||
| "framework", | ||
| "f5-framework", | ||
| "specification", | ||
| "srs", | ||
| "business-analysis", | ||
| "domain-driven", | ||
| "cli", | ||
| "claude", | ||
| "claude-code", | ||
| "specification", | ||
| "workflow", | ||
| "agents", | ||
| "mcp" | ||
| "ai-assisted", | ||
| "enterprise", | ||
| "fujigo" | ||
| ], | ||
| "author": "Fujigo", | ||
| "author": "Fujigo Software <contact@fujigo-soft.com>", | ||
| "license": "MIT", | ||
| "homepage": "https://fujigo-soft.com/f5-framework", | ||
| "bugs": { | ||
| "url": "https://fujigo-soft.com/en/contact.html" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/your-username/f5-framework" | ||
| "url": "https://fujigo-soft.com/f5-framework" | ||
| } | ||
| } |
+73
-250
| # F5 Framework CLI | ||
| [](https://www.npmjs.com/package/f5-framework-cli) | ||
| [](https://www.npmjs.com/package/f5-framework-cli) | ||
| [](https://opensource.org/licenses/MIT) | ||
| [](https://nodejs.org) | ||
| [](https://www.typescriptlang.org/) | ||
| **Enterprise spec-driven development framework for Claude Code** | ||
| **Enterprise Spec-Driven Development Toolkit** | ||
| F5 Framework transforms Claude Code into a structured development platform with specialized commands, AI agents, behavioral modes, and MCP server integrations. | ||
| F5 Framework combines Business Analysis (BA/SRS) capabilities with code generation for comprehensive software development. | ||
| ## ✨ Features | ||
| ## Features | ||
| | Category | Count | Description | | ||
| |----------|-------|-------------| | ||
| | **Commands** | 25+ | Slash commands for complete development lifecycle | | ||
| | **Agents** | 20+ | Specialized AI domain experts | | ||
| | **Modes** | 8 | Behavioral modes for different contexts | | ||
| | **MCP Servers** | 6 | Enhanced capabilities integrations | | ||
| | **Quality Gates** | 7 | D1-D4 (design) + G2-G4 (implementation) | | ||
| - 🏢 **12 Business Domains** - Fintech, E-commerce, Healthcare, Education, and more | ||
| - 📋 **Domain Knowledge** - Entities, business rules, workflows, use cases | ||
| - 🤖 **20 Specialized Agents** - BA, design, implementation, validation | ||
| - 🔄 **Quality Gates** - D1-D4 (design), G2-G4 (implementation) | ||
| - 🇻🇳 **Vietnamese Support** - Documentation in Vietnamese with English technical terms | ||
| ### Key Capabilities | ||
| ## Installation | ||
| - 🔍 **Deep Research** - Multi-hop research with MCP integration (Tavily, Context7) | ||
| - 📝 **Spec-First Development** - Documentation-first workflow (SRS → Design → Code) | ||
| - 🤖 **Agent Orchestration** - Auto-activate relevant specialists based on context | ||
| - 🎭 **Behavioral Modes** - Context-aware response optimization | ||
| - 🚦 **Quality Gates** - Automated validation checkpoints | ||
| - 🌐 **Multi-Domain** - Support for Fintech, Healthcare, Mobile, AI/ML, and more | ||
| - 🇻🇳 **Vietnamese Support** - Vietnamese documentation with English technical terms | ||
| ## 📦 Installation | ||
| ```bash | ||
| # Install globally via npm | ||
| npm install -g f5-framework-cli | ||
| # Or via yarn | ||
| yarn global add f5-framework-cli | ||
| # Verify installation | ||
| f5 --version | ||
| ``` | ||
| ## 🚀 Quick Start | ||
| ## Quick Start | ||
| ```bash | ||
| # 1. Initialize a new project | ||
| f5 init my-project --modules backend,fintech | ||
| # Check version | ||
| f5 --version | ||
| # 2. Install MCP servers for enhanced capabilities | ||
| f5 mcp install --servers tavily,context7,sequential | ||
| # Initialize project with domain | ||
| f5 init my-project --domain fintech --subdomain stock-trading | ||
| # 3. Install slash commands for Claude Code | ||
| f5 commands install | ||
| # 4. Check installation health | ||
| # Check health | ||
| f5 doctor | ||
| # 5. Restart Claude Code and start using! | ||
| # List available modules | ||
| f5 module list | ||
| ``` | ||
| ## 📋 Available Commands | ||
| ## Available Domains | ||
| ### CLI Commands | ||
| ### Business Domains | ||
| - **fintech** - Banking, Stock Trading, P2P Lending, Payment, Crypto | ||
| - **e-commerce** - B2C Retail, Marketplace, Subscription | ||
| - **healthcare** - EHR, Telemedicine, Clinic Management | ||
| - **education** - LMS, E-learning, School Management | ||
| - **entertainment** - Streaming, Gaming, Events | ||
| - **logistics** - Warehouse, Delivery, Fleet Management | ||
| - **insurance** - Life, Property, Claims | ||
| - **hr-management** - Recruitment, Payroll, Performance | ||
| - **saas-platform** - Multi-tenant, Billing, Analytics | ||
| - **manufacturing** - MES, Quality, Inventory | ||
| - **real-estate** - Property, Rental, CRM | ||
| - **travel-hospitality** - Booking, Hotel, Tours | ||
| ```bash | ||
| # Project Management | ||
| f5 init <project-name> # Initialize new F5 project | ||
| f5 status # Show workflow status | ||
| f5 doctor # Health check | ||
| ### Tech Stacks | ||
| - **Backend** - NestJS, Laravel, Spring Boot, .NET Core, Django, FastAPI, Rails, Go, Rust | ||
| - **Frontend** - React, Vue, Next.js, Angular | ||
| - **Mobile** - React Native, Flutter, iOS Native, Android Native | ||
| # MCP Server Management | ||
| f5 mcp list # List available MCP servers | ||
| f5 mcp install # Install MCP servers (interactive) | ||
| f5 mcp install --servers tavily,context7 | ||
| f5 mcp status # Show installation status | ||
| f5 mcp recommend # Show recommended combinations | ||
| ## Commands | ||
| # Agent Management | ||
| f5 agent list # List all agents | ||
| f5 agent show <name> # Show agent details | ||
| f5 agent activate "<context>" # Find agents for context | ||
| | Command | Description | | ||
| |---------|-------------| | ||
| | `f5 init <name>` | Initialize new project | | ||
| | `f5 module list` | List business domain modules | | ||
| | `f5 module show <name>` | Show module details | | ||
| | `f5 agent list` | List available agents | | ||
| | `f5 doctor` | Health check | | ||
| | `f5 status` | Show project status | | ||
| | `f5 gate <name>` | Check quality gates | | ||
| # Mode Management | ||
| f5 mode list # List behavioral modes | ||
| f5 mode activate <name> # Activate a mode | ||
| f5 mode current # Show current mode | ||
| f5 mode detect "<context>" # Detect mode from context | ||
| ## Domain Knowledge Structure | ||
| # Slash Commands | ||
| f5 commands list # List slash commands | ||
| f5 commands install # Install to Claude Code | ||
| # Quality Gates | ||
| f5 gate D1 # Check specific gate | ||
| f5 gate --all # Check all gates | ||
| # Skills | ||
| f5 skill list # List available skills | ||
| f5 skill install <name> # Install a skill | ||
| ``` | ||
| ### Slash Commands (in Claude Code) | ||
| After running `f5 commands install`: | ||
| ```bash | ||
| # Spec Phase | ||
| /f5:research "topic" # Deep research with MCP | ||
| /f5:spec --srs "feature" # Generate SRS document | ||
| /f5:design --basic # Basic architecture design | ||
| /f5:design --detail # Detail design (frontend + backend) | ||
| /f5:design --api # API contracts | ||
| # Build Phase | ||
| /f5:implement "feature" # Code generation | ||
| /f5:test --coverage # Test generation | ||
| /f5:analyze src/ # Code analysis | ||
| # Utility | ||
| /f5:help # Show command help | ||
| domains/fintech/sub-domains/stock-trading/ | ||
| ├── knowledge/ | ||
| │ ├── entities/ # Order, Position, Portfolio, Quote | ||
| │ ├── business-rules/ # Validation, Trading hours, Risk limits | ||
| │ ├── workflows/ # Order lifecycle, Margin trading | ||
| │ └── use-cases/ # 28+ use cases | ||
| └── subdomain.yaml | ||
| ``` | ||
| ## 🔌 MCP Server Integration | ||
| ## Quality Gates | ||
| F5 integrates with MCP servers for enhanced capabilities: | ||
| | Server | Description | Use Case | | ||
| |--------|-------------|----------| | ||
| | **Tavily** | Web search & discovery | Research 3x faster | | ||
| | **Context7** | Documentation lookup | Official docs access | | ||
| | **Sequential** | Multi-step reasoning | 30-50% fewer tokens | | ||
| | **Serena** | Code understanding | 2-3x faster analysis | | ||
| | **Playwright** | Browser automation | E2E testing | | ||
| | **Magic** | UI generation | React components | | ||
| ### Install Recommended Servers | ||
| ```bash | ||
| # For Research & Documentation | ||
| f5 mcp install --servers tavily,context7,sequential | ||
| # For Development | ||
| f5 mcp install --servers serena,magic | ||
| # Install all | ||
| f5 mcp install --all | ||
| ``` | ||
| ## 🤖 AI Agents | ||
| F5 includes 20+ specialized agents organized by category: | ||
| ### Spec Agents | ||
| - `srs-specialist` - Requirements specification | ||
| - `basic-design-specialist` - Architecture design | ||
| - `frontend-design-specialist` - UI/UX design | ||
| - `backend-design-specialist` - Backend architecture | ||
| - `api-contract-specialist` - API design | ||
| ### Build Agents | ||
| - `backend-engineer` - NestJS/Node.js development | ||
| - `frontend-engineer` - React/Vue development | ||
| - `security-engineer` - Security review | ||
| - `quality-engineer` - Testing & QA | ||
| - `performance-analyst` - Performance optimization | ||
| - `devops-engineer` - CI/CD & deployment | ||
| - `database-specialist` - Database design | ||
| ### Domain Agents | ||
| - `fintech-compliance` - PCI-DSS, AML, KYC | ||
| - `healthcare-compliance` - HIPAA, GDPR | ||
| - `mobile-architect` - iOS/Android/React Native | ||
| ### Auto-Activation | ||
| Agents auto-activate based on context keywords: | ||
| ```bash | ||
| # Find relevant agents | ||
| f5 agent activate "security authentication JWT" | ||
| # → Activates: security-engineer, backend-engineer | ||
| ``` | ||
| ## 🎭 Behavioral Modes | ||
| | Mode | Description | Triggers | | ||
| |------|-------------|----------| | ||
| | `spec` | Documentation-first with quality gates | `/f5:spec`, `requirements` | | ||
| | `design` | Architecture focus | `/f5:design`, `architecture` | | ||
| | `implement` | Code generation | `/f5:implement`, `build` | | ||
| | `analyze` | Code review | `/f5:analyze`, `review` | | ||
| | `test` | Test generation | `/f5:test`, `coverage` | | ||
| | `research` | Deep research with MCP | `/f5:research` | | ||
| | `token-efficient` | Minimize token usage | `--efficient` | | ||
| | `safe` | Careful changes | `--safe` | | ||
| ## 🚦 Quality Gates | ||
| ### Design Gates (D1-D4) | ||
@@ -212,95 +98,32 @@ - **D1**: Evidence ≥3 pieces, quality ≥80% | ||
| ```bash | ||
| # Check specific gate | ||
| f5 gate D1 | ||
| ## MCP Integration | ||
| # Check all gates | ||
| f5 gate --all | ||
| ``` | ||
| F5 Framework integrates with MCP servers: | ||
| ## 📁 Project Structure | ||
| | Server | Description | | ||
| |--------|-------------| | ||
| | **Context7** | Documentation lookup | | ||
| | **Sequential** | Multi-step reasoning | | ||
| | **Tavily** | Web search & research | | ||
| | **Playwright** | Browser automation | | ||
| | **Serena** | Semantic code understanding | | ||
| After `f5 init`, your project will have: | ||
| ## Version | ||
| ``` | ||
| my-project/ | ||
| ├── .f5/ | ||
| │ ├── config.json # Project configuration | ||
| │ ├── agents/ # Custom agents | ||
| │ ├── skills/ # Installed skills | ||
| │ └── evidence/ # Research evidence | ||
| ├── documents/ | ||
| │ ├── architecture/ # Architecture docs | ||
| │ └── features/ # Feature specifications | ||
| ├── CLAUDE.md # Claude Code configuration | ||
| └── README.md | ||
| ``` | ||
| Current: **1.1.1** | ||
| ## 🔧 Configuration | ||
| ## Support & Contact | ||
| ### Project Config (.f5/config.json) | ||
| For support, feature requests, or business inquiries: | ||
| ```json | ||
| { | ||
| "name": "my-project", | ||
| "version": "1.0.0", | ||
| "modules": ["backend", "fintech"], | ||
| "skills": ["backend-nestjs", "fintech-p2p"], | ||
| "confidence": 0, | ||
| "phase": "research" | ||
| } | ||
| ``` | ||
| 🌐 **Website**: [fujigo-soft.com](https://fujigo-soft.com) | ||
| ### Environment Variables | ||
| 📧 **Contact**: [Contact Us](https://fujigo-soft.com/en/contact.html) | ||
| ```bash | ||
| # Optional: Custom MCP config path | ||
| F5_MCP_CONFIG_PATH=~/.config/claude/claude_desktop_config.json | ||
| ``` | ||
| ## License | ||
| ## 📖 Documentation | ||
| MIT © [Fujigo Software](https://fujigo-soft.com) | ||
| - [Getting Started Guide](docs/getting-started.md) | ||
| - [Command Reference](docs/commands.md) | ||
| - [Agent Guide](docs/agents.md) | ||
| - [MCP Integration](docs/mcp.md) | ||
| - [Quality Gates](docs/quality-gates.md) | ||
| ## 🤝 Contributing | ||
| Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details. | ||
| ```bash | ||
| # Clone repository | ||
| git clone https://github.com/your-org/f5-framework.git | ||
| cd f5-framework | ||
| # Install dependencies | ||
| pnpm install | ||
| # Build | ||
| pnpm build | ||
| # Run tests | ||
| pnpm test | ||
| ``` | ||
| ## 📜 License | ||
| MIT License - see [LICENSE](LICENSE) for details. | ||
| ## 🙏 Acknowledgments | ||
| - Inspired by [SuperClaude Framework](https://github.com/SuperClaude-Org/SuperClaude_Framework) | ||
| - Built for [Claude Code](https://claude.ai) | ||
| - MCP integrations powered by [Anthropic MCP](https://github.com/anthropics/mcp) | ||
| --- | ||
| **Built with ❤️ for developers who demand structured, high-quality development workflows.** | ||
| <p align="center"> | ||
| <a href="https://www.npmjs.com/package/f5-framework-cli">npm</a> • | ||
| <a href="https://github.com/your-org/f5-framework">GitHub</a> • | ||
| <a href="https://github.com/your-org/f5-framework/issues">Issues</a> | ||
| </p> | ||
| **Built with ❤️ by Fujigo Software** |
Environment variable access
Supply chain riskPackage accesses environment variables, which may be a sign of credential stuffing or data theft.
Found 2 instances in 1 package
Long strings
Supply chain riskContains long string literals, which may be a sign of obfuscated or packed code.
Found 1 instance in 1 package
URL strings
Supply chain riskPackage contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.
Found 1 instance in 1 package
Environment variable access
Supply chain riskPackage accesses environment variables, which may be a sign of credential stuffing or data theft.
Found 2 instances in 1 package
Long strings
Supply chain riskContains long string literals, which may be a sign of obfuscated or packed code.
Found 1 instance in 1 package
No bug tracker
MaintenancePackage does not have a linked bug tracker in package.json.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
URL strings
Supply chain riskPackage contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.
Found 1 instance in 1 package
143736
-3.38%129
-57.7%