|
| 1 | +# Claude Code Skills for get_it |
| 2 | + |
| 3 | +This directory contains **Claude Code skill files** that help AI assistants (like Claude Code, Cursor, GitHub Copilot) generate correct get_it code efficiently. |
| 4 | + |
| 5 | +## What are Skills? |
| 6 | + |
| 7 | +Skills are concise reference guides optimized for AI consumption. They contain: |
| 8 | +- Critical rules and constraints |
| 9 | +- Common usage patterns |
| 10 | +- Anti-patterns with corrections |
| 11 | +- Integration examples |
| 12 | + |
| 13 | +**Note**: These are NOT replacements for comprehensive documentation. For detailed guides, see https://flutter-it.dev/documentation/get_it/ |
| 14 | + |
| 15 | +## Available Skills |
| 16 | + |
| 17 | +This directory includes: |
| 18 | + |
| 19 | +1. **`get_it-expert.md`** - get_it patterns, registration, scopes, async initialization |
| 20 | +2. **`flutter-architecture-expert.md`** - High-level app architecture guidance |
| 21 | + |
| 22 | +**Note**: For the ecosystem overview, see `/skills/flutter_it.md` in the monorepo root. |
| 23 | + |
| 24 | +## Installation |
| 25 | + |
| 26 | +To use these skills with Claude Code: |
| 27 | + |
| 28 | +### Option 1: Copy to Global Skills Directory (Recommended) |
| 29 | + |
| 30 | +```bash |
| 31 | +# Copy all skills to your global Claude Code skills directory |
| 32 | +cp skills/*.md ~/.claude/skills/ |
| 33 | +``` |
| 34 | + |
| 35 | +### Option 2: Symlink (Auto-updates when package updates) |
| 36 | + |
| 37 | +```bash |
| 38 | +# Create symlinks (Linux/Mac) |
| 39 | +ln -s $(pwd)/skills/get_it-expert.md ~/.claude/skills/get_it-expert.md |
| 40 | +ln -s $(pwd)/skills/flutter-architecture-expert.md ~/.claude/skills/flutter-architecture-expert.md |
| 41 | +``` |
| 42 | + |
| 43 | +### Option 3: Manual Copy (Windows) |
| 44 | + |
| 45 | +```powershell |
| 46 | +# Copy files manually |
| 47 | +copy skills\*.md %USERPROFILE%\.claude\skills\ |
| 48 | +``` |
| 49 | + |
| 50 | +## Using the Skills |
| 51 | + |
| 52 | +Once installed, Claude Code will automatically have access to these skills when working on Flutter projects. |
| 53 | + |
| 54 | +**For other AI assistants**: |
| 55 | +- **Cursor**: Copy to project root or reference in `.cursorrules` |
| 56 | +- **GitHub Copilot**: Copy to `.github/copilot-instructions.md` |
| 57 | + |
| 58 | +## Verification |
| 59 | + |
| 60 | +After installation, you can verify by asking Claude Code: |
| 61 | + |
| 62 | +``` |
| 63 | +Can you help me set up get_it for dependency injection? |
| 64 | +``` |
| 65 | + |
| 66 | +Claude should reference the skill and provide correct registration patterns. |
| 67 | + |
| 68 | +## Contents Overview |
| 69 | + |
| 70 | +### get_it-expert.md (~1200 tokens) |
| 71 | + |
| 72 | +Covers: |
| 73 | +- Basic registration patterns (singleton, lazy singleton, factory) |
| 74 | +- Async initialization with `allReady()` |
| 75 | +- Scopes for session management |
| 76 | +- Named instances |
| 77 | +- Disposal patterns |
| 78 | +- Testing patterns |
| 79 | +- Common anti-patterns |
| 80 | + |
| 81 | +### flutter-architecture-expert.md (~800 tokens) |
| 82 | + |
| 83 | +Covers: |
| 84 | +- Startup orchestration with get_it |
| 85 | +- Layer structure (domain/data/presentation) |
| 86 | +- State management with managers |
| 87 | +- Scoped services for user sessions |
| 88 | +- Testing patterns |
| 89 | + |
| 90 | +## Documentation Links |
| 91 | + |
| 92 | +- **Comprehensive docs**: https://flutter-it.dev/documentation/get_it/ |
| 93 | +- **Package README**: https://pub.dev/packages/get_it |
| 94 | +- **GitHub**: https://github.com/escamoteur/get_it |
| 95 | +- **Discord**: https://discord.gg/ZHYHYCM38h |
| 96 | + |
| 97 | +## Contributing |
| 98 | + |
| 99 | +Found an issue or have suggestions for improving these skills? |
| 100 | +- Open an issue on GitHub |
| 101 | +- Join the Discord community |
| 102 | +- Submit a PR with improvements |
| 103 | + |
| 104 | +--- |
| 105 | + |
| 106 | +**Note**: These skills are designed for AI consumption. For human-readable documentation, please visit https://flutter-it.dev |
0 commit comments