UNPKG

hey-claudio

Version:

πŸ€– HeyClaudio: AI-powered development assistant with R.A.D.A.R. analysis + C.I.D.E.R. atomic issues for Claude IDE

273 lines (214 loc) β€’ 7.88 kB
# πŸ€– HeyClaudio - AI-Powered Development Assistant **Setup once, develop with AI everywhere.** HeyClaudio transforms any repository into an AI-powered development environment with **R.A.D.A.R. analysis** and **C.I.D.E.R. atomic issues** for Claude IDE. ## πŸš€ Quick Start ```bash # 1. Install globally npm i -g hey-claudio # 2. Setup in any project cd your-project claudio init # 3. Start developing with AI claude # Then use: /radar:analyze, /cider:generate, /cider:work ``` ## ✨ What You Get ### 🎯 **Smart Project Setup** - **One command setup**: `claudio init` configures everything - **Smart detection**: Automatically detects your tech stack - **Claude IDE integration**: Native slash commands ready to use ### πŸ” **R.A.D.A.R. Analysis** - **R**econocimiento: Codebase structure and architecture - **A**nΓ‘lisis: Code quality, patterns, dependencies - **D**ocumentaciΓ³n: Missing docs, outdated content - **A**rquitectura: Design decisions and improvements - **R**ecomendaciones: Actionable improvement suggestions ### 🎯 **C.I.D.E.R. Atomic Issues** - **C**ontextualizar: Understand current project state - **I**terar: Plan approach and break into tasks - **D**ocumentar: Create specifications and requirements - **E**jecutar: Define implementation steps - **R**eflexionar: Plan testing and validation ## πŸ“‹ Usage ### **Setup (One Time)** ```bash npm i -g hey-claudio cd your-project claudio init # Creates .claude/ structure + slash commands ``` ### **Daily Development** ```bash claudio status # Check project status claude # Open Claude IDE # Inside Claude IDE: /radar:analyze # Complete project analysis /radar:quick # Quick project overview /cider:generate EPIC-API "implement auth" # Generate atomic issues /cider:work 123 # Work on specific issue /cider:status # Project status overview /cider:list-epics # Show available epics ``` ### **Quick Commands** ```bash claudio # Show status + next steps claudio open # Open Claude IDE claudio analyze # Quick analysis without Claude IDE claudio check # Verify configuration ``` ## πŸ—οΈ Project Structure Created ``` your-project/ β”œβ”€β”€ .claude/ β”‚ β”œβ”€β”€ commands/ # Native slash commands β”‚ β”‚ β”œβ”€β”€ radar/ # Analysis commands β”‚ β”‚ └── cider/ # Issue management commands β”‚ β”œβ”€β”€ current/ # Active project state β”‚ β”‚ β”œβ”€β”€ project-state.md β”‚ β”‚ β”œβ”€β”€ active-epic.md β”‚ β”‚ └── next-session.md β”‚ β”œβ”€β”€ epics/ # Epic management β”‚ β”‚ └── epics-roadmap.md β”‚ β”œβ”€β”€ sessions/ # Session history β”‚ β”œβ”€β”€ guides/ # Development methodology β”‚ └── templates/ # Reusable templates └── analysis/ # Generated analysis reports ``` ## 🎯 Workflow ### **1. Project Initialization** ```bash claudio init # βœ… Creates .claude/ structure # βœ… Detects tech stack # βœ… Creates suggested epics # βœ… Sets up development methodology ``` ### **2. Analysis & Understanding** ```bash claude # Open Claude IDE /radar:analyze # Complete analysis # βœ… Architecture analysis # βœ… Code quality assessment # βœ… Improvement recommendations # βœ… Epic suggestions ``` ### **3. Issue Generation** ```bash /cider:generate EPIC-FRONTEND "implement responsive design" # βœ… Creates atomic issue (2-6 hours) # βœ… Defines acceptance criteria # βœ… Plans implementation approach # βœ… Sets up C.I.D.E.R. workflow ``` ### **4. Development Execution** ```bash /cider:work 123 # βœ… Loads issue context # βœ… Plans work approach # βœ… Tracks progress # βœ… Updates project state ``` ## πŸ”§ Available Slash Commands | Command | Description | |---------|-------------| | `/radar:analyze` | Complete project analysis with recommendations | | `/radar:quick` | Quick project overview and status | | `/cider:generate EPIC "desc"` | Generate atomic development issue | | `/cider:work ISSUE_NUMBER` | Work on specific issue with guidance | | `/cider:status` | Show project and epic status | | `/cider:list-epics` | List all available epics | | `/init:claude` | Generate CLAUDE.md with complete methodology | ## 🎨 Example Epic Types HeyClaudio automatically suggests epics based on your tech stack: - **EPIC-FRONTEND**: User interface development - **EPIC-BACKEND**: Server-side development - **EPIC-DATABASE**: Data management - **EPIC-API**: API development - **EPIC-TESTING**: Quality assurance - **EPIC-DEPLOYMENT**: DevOps & infrastructure - **EPIC-PERFORMANCE**: Optimization - **EPIC-SECURITY**: Security implementation - **EPIC-DOCS**: Documentation ## πŸ” Example Analysis Output ```bash /radar:analyze ``` Generates comprehensive reports: - **Executive Summary**: Key findings and priorities - **Architecture Analysis**: Structure and design patterns - **Code Quality**: Issues and improvements - **Dependency Analysis**: Package management and updates - **Documentation Review**: Missing or outdated docs - **Security Assessment**: Potential vulnerabilities - **Performance Analysis**: Optimization opportunities ## 🎯 Atomic Issue Example ```bash /cider:generate EPIC-API "implement user authentication" ``` Creates issue with: - βœ… **Clear objectives** and acceptance criteria - βœ… **Task breakdown** (2-6 hour target) - βœ… **Implementation approach** and technical requirements - βœ… **Testing strategy** and validation steps - βœ… **Files to modify** and integration points - βœ… **C.I.D.E.R. workflow** tracking ## πŸš€ Benefits ### **For Individual Developers** - βœ… **Instant project understanding** with R.A.D.A.R. analysis - βœ… **Structured development** with C.I.D.E.R. methodology - βœ… **Clear work breakdown** into atomic issues - βœ… **Progress tracking** and session management ### **For Teams** - βœ… **Consistent methodology** across projects - βœ… **Knowledge sharing** through documentation - βœ… **Quality standards** with built-in best practices - βœ… **Project visibility** with status tracking ### **For Freelancers/Consultants** - βœ… **Quick client onboarding** with instant analysis - βœ… **Professional reporting** with detailed insights - βœ… **Structured proposals** based on epic breakdown - βœ… **Progress transparency** for clients ## πŸ› οΈ Requirements - **Node.js** 14+ - **Claude IDE** ([Download here](https://claude.ai/download)) - **Git** (recommended) ## πŸ“¦ Installation ### Global Installation (Recommended) ```bash npm i -g hey-claudio ``` ### Local Installation ```bash cd your-project npm i hey-claudio npx hey-claudio init ``` ## πŸ†˜ Support Having issues? Check common solutions: ### **"claude command not found"** Install Claude IDE: https://claude.ai/download ### **"Project not setup"** ```bash claudio init ``` ### **"No slash commands available"** ```bash claudio check # Verify setup claudio init # Re-initialize if needed ``` ### **Debug Mode** ```bash CLAUDIO_DEBUG=true claudio init ``` ## 🎯 Perfect For - βœ… **New project onboarding** - Understand any codebase instantly - βœ… **Legacy code analysis** - Get insights into old projects - βœ… **Freelance work** - Professional analysis and structured development - βœ… **Team collaboration** - Consistent methodology and documentation - βœ… **Code reviews** - Structured analysis and improvement suggestions - βœ… **Technical debt** - Identify and plan improvements systematically ## 🀝 Contributing This project is designed to work seamlessly with Claude IDE and AI-powered development workflows. ## πŸ“„ License MIT - Build amazing things with AI assistance! --- **πŸ€– HeyClaudio - Making every developer an AI-powered expert**