claude-all-config 2.1.5 → 2.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -11,19 +11,40 @@ Auto-detects installed CLIs and configures them with agents, skills, commands, M
11
11
 
12
12
  ## ⚡ Quick Install
13
13
 
14
- ### Option 1: curl (Recommended)
14
+ ### 🐧 Linux / Ubuntu / Mac
15
+
15
16
  ```bash
17
+ # Option 1: curl (Recommended)
16
18
  curl -fsSL https://raw.githubusercontent.com/zesbe/ClaudeAll/main/install.sh | bash
19
+
20
+ # Option 2: npm
21
+ npm install -g claude-all-config
17
22
  ```
18
23
 
19
- ### Option 2: npm
24
+ ### 📱 Termux Android
25
+
20
26
  ```bash
27
+ # Install prerequisites
28
+ pkg install nodejs-lts git
29
+
30
+ # Install Claude Code / Gemini CLI
31
+ npm install -g @anthropic-ai/claude-code
32
+ npm install -g @google/gemini-cli
33
+
34
+ # Install superpowers
21
35
  npm install -g claude-all-config
22
36
  ```
23
37
 
38
+ **Termux Paths:** `/data/data/com.termux/files/home/.claude/`
39
+
40
+ > 📖 See [TERMUX.md](./TERMUX.md) for detailed Termux documentation.
41
+
42
+ ---
43
+
24
44
  **Auto-detects and installs to:**
25
45
  - ✅ Claude Code → `~/.claude/`
26
46
  - ✅ Gemini CLI → `~/.gemini/superpowers/`
47
+ - ✅ Termux → `/data/data/com.termux/files/home/.claude/`
27
48
 
28
49
  ---
29
50
 
@@ -0,0 +1,69 @@
1
+ ---
2
+ description: Clean the codebase or current working task in focus via Prettier, Import Sorter, ESLint, and TypeScript Compiler
3
+ ---
4
+
5
+ # Code Quality Cleanup
6
+
7
+ You are a code quality specialist. When provided with $ARGUMENTS (file paths or directories), systematically clean and optimize the code for production readiness. If no arguments provided, focus on currently open or recently modified files.
8
+
9
+ ## Your Cleanup Process:
10
+
11
+ **Step 1: Analyze Target Scope**
12
+ - If $ARGUMENTS provided: Focus on specified files/directories
13
+ - If no arguments: Check git status for modified files and currently open files
14
+ - Identify file types and applicable cleanup tools
15
+
16
+ **Step 2: Execute Cleanup Pipeline**
17
+ Perform these actions in order:
18
+
19
+ 1. **Remove Debug Code**
20
+ - Strip console.log, debugger statements, and temporary debugging code
21
+ - Remove commented-out code blocks
22
+ - Clean up development-only imports
23
+
24
+ 2. **Format Code Structure**
25
+ - Run Prettier (if available) or apply consistent formatting
26
+ - Ensure proper indentation and spacing
27
+ - Standardize quote usage and trailing commas
28
+
29
+ 3. **Optimize Imports**
30
+ - Sort imports alphabetically
31
+ - Remove unused imports
32
+ - Group imports by type (libraries, local files)
33
+ - Use absolute imports where configured
34
+
35
+ 4. **Fix Linting Issues**
36
+ - Resolve ESLint/TSLint errors and warnings
37
+ - Apply auto-fixable rules
38
+ - Report manual fixes needed
39
+
40
+ 5. **Type Safety Validation**
41
+ - Run TypeScript compiler checks
42
+ - Fix obvious type issues
43
+ - Add missing type annotations where beneficial
44
+
45
+ 6. **Comment Optimization**
46
+ - Remove redundant or obvious comments
47
+ - Improve unclear comments
48
+ - Ensure JSDoc/docstring completeness for public APIs
49
+
50
+ **Step 3: Present Cleanup Report**
51
+
52
+ ## Cleanup Results
53
+
54
+ ### Files Processed
55
+ - [List of files that were cleaned]
56
+
57
+ ### Actions Taken
58
+ - **Debug Code Removed**: [Number of console.logs, debuggers removed]
59
+ - **Formatting Applied**: [Files formatted]
60
+ - **Imports Optimized**: [Unused imports removed, sorting applied]
61
+ - **Linting Issues Fixed**: [Auto-fixed issues count]
62
+ - **Type Issues Resolved**: [TypeScript errors fixed]
63
+ - **Comments Improved**: [Redundant comments removed, unclear ones improved]
64
+
65
+ ### Manual Actions Needed
66
+ - [List any issues that require manual intervention]
67
+
68
+ ### Quality Improvements
69
+ - [Summary of overall code quality improvements made]
@@ -0,0 +1,131 @@
1
+ ---
2
+ description: Smart commit command with automatic validation and conventional commits
3
+ ---
4
+
5
+ # Smart Commit Command
6
+
7
+ You are an AI agent that helps create well-formatted git commits. This command handles the complete commit workflow including validation, testing, and pushing changes.
8
+
9
+ ## Instructions for Agent
10
+
11
+ When the user runs this command, execute the following workflow:
12
+
13
+ ### 1. **Smart Repo Analysis (Automatic)**
14
+
15
+ **Before doing anything, analyze the repo state:**
16
+
17
+ ```bash
18
+ # Check current branch and status
19
+ git status
20
+ git branch --show-current
21
+
22
+ # Check recent commits for style
23
+ git log --oneline -5
24
+ ```
25
+
26
+ ### 2. **Analyze Changes**
27
+ - Run `git status` to see all untracked files
28
+ - Run `git diff` to see both staged and unstaged changes
29
+ - Run `git log --oneline -5` to see recent commit style
30
+ - Identify the scope of changes
31
+
32
+ ### 3. **Stage Files Intelligently**
33
+ **Auto-stage based on change type:**
34
+ - If modifying agents → stage `agents/`
35
+ - If modifying skills → stage `skills/`
36
+ - If modifying commands → stage `commands/`
37
+ - If modifying context → stage `context/`
38
+ - If modifying hooks → stage `hooks/`
39
+ - If modifying docs → stage `docs/`
40
+ - If modifying CI/CD → stage `.github/workflows/`
41
+ - If user provides specific files → stage only those
42
+
43
+ **Never auto-stage:**
44
+ - `node_modules/`
45
+ - `.env` files
46
+ - Temporary directories
47
+
48
+ ### 4. **Generate Commit Message**
49
+
50
+ **Follow Conventional Commits (NO EMOJIS):**
51
+ ```
52
+ <type>(<scope>): <description>
53
+
54
+ [optional body]
55
+ ```
56
+
57
+ **Types:**
58
+ - `feat` - New features
59
+ - `fix` - Bug fixes
60
+ - `refactor` - Code restructuring
61
+ - `test` - Test additions
62
+ - `docs` - Documentation updates
63
+ - `chore` - Maintenance tasks
64
+ - `ci` - CI/CD changes
65
+ - `perf` - Performance improvements
66
+
67
+ **Scopes:**
68
+ - `agents` - Agent changes
69
+ - `skills` - Skill changes
70
+ - `commands` - Command changes
71
+ - `context` - Context file changes
72
+ - `hooks` - Hook changes
73
+ - `mcp` - MCP server changes
74
+ - `docs` - Documentation changes
75
+
76
+ **Examples:**
77
+ ```
78
+ feat(agents): add new code-generator agent
79
+ fix(skills): correct brainstorming skill logic
80
+ refactor(commands): split commit command into modules
81
+ docs(readme): update installation instructions
82
+ chore(deps): upgrade dependencies
83
+ ```
84
+
85
+ ### 5. **Execute Commit**
86
+ ```bash
87
+ git add <relevant-files>
88
+ git commit -m "<type>(<scope>): <description>"
89
+ git status # Verify commit succeeded
90
+ ```
91
+
92
+ ### 6. **Post-Commit Actions**
93
+
94
+ **Ask user:**
95
+ ```
96
+ ✅ Commit created: <commit-hash>
97
+ 📝 Message: <commit-message>
98
+
99
+ Would you like to:
100
+ 1. Push to remote (git push origin <branch>)
101
+ 2. Create another commit
102
+ 3. Done
103
+ ```
104
+
105
+ ## Error Handling
106
+
107
+ ### If No Changes Detected
108
+ ```
109
+ ℹ️ No changes to commit. Working tree is clean.
110
+
111
+ Recent commits:
112
+ <git log --oneline -3>
113
+ ```
114
+
115
+ ### If Merge Conflicts
116
+ ```
117
+ ⚠️ Merge conflicts detected. Please resolve conflicts first.
118
+
119
+ Conflicted files:
120
+ <list-files>
121
+ ```
122
+
123
+ ## Success Criteria
124
+
125
+ A successful commit should:
126
+ - ✅ Follow conventional commit format (NO EMOJIS)
127
+ - ✅ Have appropriate scope
128
+ - ✅ Be atomic (single purpose)
129
+ - ✅ Have clear, concise message
130
+ - ✅ Not include sensitive information
131
+ - ✅ Not include generated files
@@ -0,0 +1,32 @@
1
+ ---
2
+ description: Analyze database queries and recommend missing indexes
3
+ argument-hint: Optional - specific tables or queries to analyze
4
+ ---
5
+
6
+ # Database Index Analysis
7
+
8
+ **Scope:** `$ARGUMENTS` (or entire codebase if not specified)
9
+
10
+ Scan whole codebase and tell me what indexes are missing.
11
+
12
+ ## 📚 **DOCUMENTATION REQUIREMENTS**
13
+
14
+ **Create comprehensive database analysis documentation at:**
15
+ - `docs/tasks/backend/DD-MM-YYYY/<semantic-db-id>/`
16
+
17
+ **Documentation Structure:**
18
+ - `README.md` - Database analysis overview and objectives
19
+ - `query-analysis.md` - Detailed query performance analysis
20
+ - `index-recommendations.md` - Missing indexes and impact analysis
21
+ - `performance-metrics.md` - Before/after performance comparisons
22
+ - `implementation-plan.md` - Index creation strategy and migration plan
23
+ - `monitoring-setup.md` - Performance monitoring and alerting
24
+
25
+ **Semantic Database Task ID Examples:**
26
+ - `user-query-optimization`
27
+ - `order-performance-indexes`
28
+ - `search-query-acceleration`
29
+ - `relationship-index-analysis`
30
+ - `slow-query-investigation`
31
+
32
+ Please analyze all database queries, identify missing indexes, and document recommendations according to the standards above.
@@ -0,0 +1,87 @@
1
+ ---
2
+ description: Manage git worktrees for parallel development workflows
3
+ ---
4
+
5
+ # Git Worktree Management
6
+
7
+ You are a git workflow specialist. When provided with $ARGUMENTS, manage git worktrees to enable parallel development on multiple branches. Common arguments: "create", "list", "cleanup", or specific branch names.
8
+
9
+ ## Your Worktree Management Process:
10
+
11
+ **Step 1: Assess Current State**
12
+ - Check if git worktrees are already in use with `git worktree list`
13
+ - Verify GitHub CLI is available and authenticated for PR operations
14
+ - Identify the main repository directory structure
15
+ - Check for existing `./tree` directory or similar worktree organization
16
+
17
+ **Step 2: Execute Worktree Operations**
18
+
19
+ ### Create Worktrees for All Open PRs
20
+ When $ARGUMENTS includes "prs" or "all":
21
+ 1. Run `gh pr list --json headRefName,title,number` to get open PRs
22
+ 2. For each PR branch:
23
+ - Create directory structure: `./tree/[branch-name]`
24
+ - Execute `git worktree add ./tree/[branch-name] [branch-name]`
25
+ - Handle branch names with slashes by creating nested directories
26
+ 3. Report successful worktree creation
27
+
28
+ ### Create Worktree for Specific Branch
29
+ When $ARGUMENTS specifies a branch name:
30
+ 1. Check if branch exists locally or remotely
31
+ 2. Create worktree at `./tree/[branch-name]`
32
+ 3. If branch doesn't exist, offer to create it with `git worktree add -b [branch-name] ./tree/[branch-name]`
33
+
34
+ ### Create New Branch with Worktree
35
+ When $ARGUMENTS includes "new" and a branch name:
36
+ 1. Prompt for base branch (default: main/master)
37
+ 2. Create new branch and worktree simultaneously
38
+ 3. Set up proper tracking if needed
39
+
40
+ ### List and Status Check
41
+ When $ARGUMENTS includes "list" or "status":
42
+ 1. Show all current worktrees with `git worktree list`
43
+ 2. Check status of each worktree
44
+ 3. Identify any stale or problematic worktrees
45
+
46
+ ### Cleanup Operations
47
+ When $ARGUMENTS includes "cleanup":
48
+ 1. Identify branches that no longer exist remotely
49
+ 2. Remove corresponding worktrees safely
50
+ 3. Clean up empty directories in `./tree`
51
+
52
+ **Step 3: Present Worktree Report**
53
+
54
+ ## Worktree Management Results
55
+
56
+ ### Operation Summary
57
+ - **Command**: [What operation was performed]
58
+ - **Target**: [Specific branches or "all open PRs"]
59
+ - **Location**: [Worktree directory structure used]
60
+
61
+ ### Active Worktrees
62
+ ```
63
+ [List of active worktrees with format:]
64
+ /path/to/main/repo [main branch] (main repository)
65
+ /path/to/tree/feature-123 [feature-123] (worktree)
66
+ /path/to/tree/bugfix-456 [bugfix-456] (worktree)
67
+ ```
68
+
69
+ ### Actions Completed
70
+ - **Created**: [Number of new worktrees created]
71
+ - **Removed**: [Number of stale worktrees cleaned up]
72
+ - **Skipped**: [Worktrees that already existed]
73
+
74
+ ### Directory Structure
75
+ ```
76
+ project/
77
+ ├── main repository files
78
+ └── tree/
79
+ ├── feature-branch-1/
80
+ ├── feature-branch-2/
81
+ └── bugfix-branch/
82
+ ```
83
+
84
+ ### Next Steps
85
+ - **To work on a branch**: `cd tree/[branch-name]`
86
+ - **To switch branches**: Use different worktree directories
87
+ - **To clean up later**: Use `/worktrees cleanup` command
@@ -0,0 +1,13 @@
1
+ ---
2
+ description: Create a detailed implementation plan
3
+ argument-hint: [design-doc-path]
4
+ ---
5
+
6
+ # Write Implementation Plan
7
+
8
+ **User Input:** $ARGUMENTS
9
+
10
+ **Instructions:**
11
+ 1. **Target:** I want to create a detailed implementation plan.
12
+ 2. **Action:** Please **invoke/use the `writing-plans` skill** immediately.
13
+ 3. Refer to the design document or requirements in "$ARGUMENTS" (if provided).
@@ -0,0 +1,27 @@
1
+ # Context Files
2
+
3
+ Context files provide domain knowledge, process documentation, and templates that agents can reference.
4
+
5
+ ## Structure
6
+
7
+ ```
8
+ context/
9
+ ├── core/ # Core system knowledge
10
+ ├── development/ # Development practices and patterns
11
+ ├── data/ # Data handling and processing
12
+ ├── content/ # Content creation guidelines
13
+ ├── project/ # Project management context
14
+ ├── ui/ # UI/UX design patterns
15
+ └── templates/ # Reusable templates
16
+ ```
17
+
18
+ ## Usage
19
+
20
+ Agents automatically load relevant context based on the task type. You can also explicitly reference context files in prompts.
21
+
22
+ ## Adding Context
23
+
24
+ 1. Create a new .md file in the appropriate subdirectory
25
+ 2. Follow the standard format with frontmatter
26
+ 3. Keep files focused (50-200 lines)
27
+ 4. Include examples where helpful
package/install.sh CHANGED
@@ -79,6 +79,7 @@ install_claude() {
79
79
  mkdir -p "$HOME/.claude/commands"
80
80
  mkdir -p "$HOME/.claude/hooks"
81
81
  mkdir -p "$HOME/.claude/plugins"
82
+ mkdir -p "$HOME/.claude/context"
82
83
 
83
84
  cp -r "$REPO_DIR/agents/"* "$HOME/.claude/agents/" 2>/dev/null || true
84
85
  AGENT_COUNT=$(ls -1 "$HOME/.claude/agents/"*.md 2>/dev/null | wc -l)
@@ -98,9 +99,12 @@ install_claude() {
98
99
  cp "$REPO_DIR/plugins/installed_plugins.json" "$HOME/.claude/plugins/" 2>/dev/null || true
99
100
  echo -e " ${GREEN}✅ plugins${NC}"
100
101
 
102
+ cp -r "$REPO_DIR/context/"* "$HOME/.claude/context/" 2>/dev/null || true
103
+ echo -e " ${GREEN}✅ context files${NC}"
104
+
101
105
  cp "$REPO_DIR/mcp.json" "$HOME/.mcp.json" 2>/dev/null || true
102
106
  chmod 600 "$HOME/.mcp.json" 2>/dev/null || true
103
- echo -e " ${GREEN}✅ MCP config (6 servers)${NC}"
107
+ echo -e " ${GREEN}✅ MCP config (7 servers)${NC}"
104
108
 
105
109
  cat > "$HOME/.claude/settings.local.json" << 'EOF'
106
110
  {
@@ -154,7 +158,7 @@ install_gemini() {
154
158
 
155
159
  cp "$REPO_DIR/mcp.json" "$HOME/.gemini/mcp.json" 2>/dev/null || true
156
160
  chmod 600 "$HOME/.gemini/mcp.json" 2>/dev/null || true
157
- echo -e " ${GREEN}✅ MCP config (6 servers)${NC}"
161
+ echo -e " ${GREEN}✅ MCP config (7 servers)${NC}"
158
162
 
159
163
  cat > "$HOME/.gemini/GEMINI.md" << 'EOF'
160
164
  # Gemini Superpowers
@@ -175,8 +179,8 @@ executing-plans, and more...
175
179
  ## Commands
176
180
  /brainstorm, /write-plan, /execute-plan
177
181
 
178
- ## MCP Servers (6)
179
- context7, exa, sequential-thinking, memory, filesystem, fetch
182
+ ## MCP Servers (7)
183
+ context7, exa, sequential-thinking, memory, filesystem, fetch, web-reader
180
184
 
181
185
  ## Usage
182
186
  Run with YOLO mode: gemini -y
@@ -225,7 +229,7 @@ fi
225
229
 
226
230
  # Install MCP packages (shared)
227
231
  echo "📦 Installing MCP packages..."
228
- npm install -g @upstash/context7-mcp @modelcontextprotocol/server-sequential-thinking exa-mcp-server @modelcontextprotocol/server-memory @modelcontextprotocol/server-filesystem @kazuph/mcp-fetch 2>/dev/null || {
232
+ npm install -g @upstash/context7-mcp @modelcontextprotocol/server-sequential-thinking exa-mcp-server @modelcontextprotocol/server-memory @modelcontextprotocol/server-filesystem @kazuph/mcp-fetch @modelcontextprotocol/server-web-reader 2>/dev/null || {
229
233
  echo -e "${YELLOW}⚠️ Some MCP packages may need manual install${NC}"
230
234
  }
231
235
  echo -e "${GREEN}✅ MCP packages installed${NC}"
package/mcp.json CHANGED
@@ -29,6 +29,11 @@
29
29
  "fetch": {
30
30
  "command": "npx",
31
31
  "args": ["-y", "@wordbricks/fetch-mcp@latest"]
32
+ },
33
+ "web-reader": {
34
+ "command": "npx",
35
+ "args": ["-y", "@modelcontextprotocol/server-web-reader"],
36
+ "description": "Read and convert web content to LLM-friendly format"
32
37
  }
33
38
  }
34
39
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "claude-all-config",
3
- "version": "2.1.5",
3
+ "version": "2.1.7",
4
4
  "description": "🤖 Universal AI CLI Config - Claude Code + Gemini CLI with Agents, Skills, MCP Servers, 17+ Providers (MiniMax, OpenAI, xAI, Groq, DeepSeek, Letta & More)",
5
5
  "main": "index.js",
6
6
  "bin": {
@@ -53,6 +53,7 @@
53
53
  "agents/",
54
54
  "skills/",
55
55
  "commands/",
56
+ "context/",
56
57
  "hooks/",
57
58
  "plugins/",
58
59
  "bin/",
package/postinstall.js CHANGED
@@ -68,7 +68,7 @@ function installClaude() {
68
68
  console.log('📦 Installing to Claude (~/.claude/)...');
69
69
 
70
70
  // Create directories
71
- const dirs = ['agents', 'skills', 'commands', 'hooks', 'plugins'];
71
+ const dirs = ['agents', 'skills', 'commands', 'hooks', 'plugins', 'context'];
72
72
  dirs.forEach(dir => {
73
73
  const targetDir = path.join(CLAUDE_DIR, dir);
74
74
  if (!fs.existsSync(targetDir)) {
@@ -94,13 +94,18 @@ function installClaude() {
94
94
  console.log(` 🔌 plugins`);
95
95
  }
96
96
 
97
+ if (fs.existsSync(path.join(PKG_DIR, 'context'))) {
98
+ const contextCount = copyDir(path.join(PKG_DIR, 'context'), path.join(CLAUDE_DIR, 'context'));
99
+ console.log(` 📂 ${contextCount} context files`);
100
+ }
101
+
97
102
  // MCP config
98
103
  const mcpSrc = path.join(PKG_DIR, 'mcp.json');
99
104
  const mcpDest = path.join(HOME, '.mcp.json');
100
105
  if (fs.existsSync(mcpSrc)) {
101
106
  fs.copyFileSync(mcpSrc, mcpDest);
102
107
  fs.chmodSync(mcpDest, 0o600);
103
- console.log(` 🔧 MCP config (6 servers)`);
108
+ console.log(` 🔧 MCP config (7 servers)`);
104
109
  }
105
110
 
106
111
  // Settings
@@ -166,7 +171,7 @@ function installGemini() {
166
171
  if (fs.existsSync(mcpSrc)) {
167
172
  fs.copyFileSync(mcpSrc, mcpDest);
168
173
  fs.chmodSync(mcpDest, 0o600);
169
- console.log(` 🔧 MCP config (6 servers)`);
174
+ console.log(` 🔧 MCP config (7 servers)`);
170
175
  }
171
176
 
172
177
  // GEMINI.md
@@ -188,8 +193,8 @@ executing-plans, and more...
188
193
  ## Commands
189
194
  /brainstorm, /write-plan, /execute-plan
190
195
 
191
- ## MCP Servers (6)
192
- context7, exa, sequential-thinking, memory, filesystem, fetch
196
+ ## MCP Servers (7)
197
+ context7, exa, sequential-thinking, memory, filesystem, fetch, web-reader
193
198
 
194
199
  ## Usage
195
200
  Run with YOLO mode: gemini -y
@@ -0,0 +1,71 @@
1
+ ---
2
+ name: agents-md-generator
3
+ description: Generate hierarchical AGENTS.md structures for codebases. Use when user asks to create AGENTS.md files, analyze codebase for AI agent documentation, set up AI-friendly project documentation, or generate context files for AI coding assistants. Triggers on "create AGENTS.md", "generate agents", "analyze codebase for AI", "AI documentation setup", "hierarchical agents".
4
+ ---
5
+
6
+ # AGENTS.md Generator
7
+
8
+ Generate hierarchical AGENTS.md structures optimized for AI coding agents with minimal token usage.
9
+
10
+ ## Core Principles
11
+
12
+ 1. **Root AGENTS.md is LIGHTWEIGHT** - Only universal guidance, links to sub-files (~100-200 lines max)
13
+ 2. **Nearest-wins hierarchy** - Agents read closest AGENTS.md to file being edited
14
+ 3. **JIT indexing** - Provide paths/globs/commands, NOT full content
15
+ 4. **Token efficiency** - Small, actionable guidance over encyclopedic docs
16
+ 5. **Sub-folder files have MORE detail** - Specific patterns, examples, commands
17
+
18
+ ## Workflow
19
+
20
+ ### Phase 1: Repository Analysis
21
+
22
+ Analyze and report:
23
+ 1. **Repository type**: Monorepo, multi-package, or simple?
24
+ 2. **Tech stack**: Languages, frameworks, key tools
25
+ 3. **Major directories** needing own AGENTS.md
26
+ 4. **Build system**: pnpm/npm/yarn workspaces? Turborepo?
27
+ 5. **Testing setup**: Jest, Vitest, Playwright, pytest?
28
+ 6. **Key patterns**: Organization, conventions, examples
29
+
30
+ ### Phase 2: Root AGENTS.md
31
+
32
+ Create lightweight root (~100-200 lines):
33
+
34
+ ```markdown
35
+ # Project Name
36
+
37
+ ## Project Snapshot
38
+ [3-5 lines: repo type, tech stack, note about sub-AGENTS.md files]
39
+
40
+ ## Root Setup Commands
41
+ [5-10 lines: install, build all, typecheck all, test all]
42
+
43
+ ## Universal Conventions
44
+ [5-10 lines: code style, commit format, branch strategy]
45
+
46
+ ## JIT Index
47
+ - Web UI: `apps/web/` -> [see apps/web/AGENTS.md](apps/web/AGENTS.md)
48
+ - API: `apps/api/` -> [see apps/api/AGENTS.md](apps/api/AGENTS.md)
49
+
50
+ ## Definition of Done
51
+ [3-5 lines: what must pass before PR]
52
+ ```
53
+
54
+ ### Phase 3: Sub-Folder AGENTS.md
55
+
56
+ For each major package, create detailed AGENTS.md with:
57
+ - Package Identity
58
+ - Setup & Run commands
59
+ - Patterns & Conventions (with real file examples)
60
+ - Key Files
61
+ - JIT Index Hints
62
+ - Common Gotchas
63
+ - Pre-PR Checks
64
+
65
+ ## Quality Checklist
66
+
67
+ - [ ] Root AGENTS.md under 200 lines
68
+ - [ ] Root links to all sub-AGENTS.md files
69
+ - [ ] Each sub-file has concrete examples (actual paths)
70
+ - [ ] Commands are copy-paste ready
71
+ - [ ] No duplication between root and sub-files
@@ -0,0 +1,74 @@
1
+ ---
2
+ name: artifacts-builder
3
+ description: Suite of tools for creating elaborate, multi-component claude.ai HTML artifacts using modern frontend web technologies (React, Tailwind CSS, shadcn/ui). Use for complex artifacts requiring state management, routing, or shadcn/ui components - not for simple single-file HTML/JSX artifacts.
4
+ license: Complete terms in LICENSE.txt
5
+ ---
6
+
7
+ # Artifacts Builder
8
+
9
+ To build powerful frontend claude.ai artifacts, follow these steps:
10
+ 1. Initialize the frontend repo using `scripts/init-artifact.sh`
11
+ 2. Develop your artifact by editing the generated code
12
+ 3. Bundle all code into a single HTML file using `scripts/bundle-artifact.sh`
13
+ 4. Display artifact to user
14
+ 5. (Optional) Test the artifact
15
+
16
+ **Stack**: React 18 + TypeScript + Vite + Parcel (bundling) + Tailwind CSS + shadcn/ui
17
+
18
+ ## Design & Style Guidelines
19
+
20
+ VERY IMPORTANT: To avoid what is often referred to as "AI slop", avoid using excessive centered layouts, purple gradients, uniform rounded corners, and Inter font.
21
+
22
+ ## Quick Start
23
+
24
+ ### Step 1: Initialize Project
25
+
26
+ Run the initialization script to create a new React project:
27
+ ```bash
28
+ bash scripts/init-artifact.sh <project-name>
29
+ cd <project-name>
30
+ ```
31
+
32
+ This creates a fully configured project with:
33
+ - React + TypeScript (via Vite)
34
+ - Tailwind CSS 3.4.1 with shadcn/ui theming system
35
+ - Path aliases (`@/`) configured
36
+ - 40+ shadcn/ui components pre-installed
37
+ - All Radix UI dependencies included
38
+ - Parcel configured for bundling (via .parcelrc)
39
+ - Node 18+ compatibility (auto-detects and pins Vite version)
40
+
41
+ ### Step 2: Develop Your Artifact
42
+
43
+ To build the artifact, edit the generated files. See **Common Development Tasks** below for guidance.
44
+
45
+ ### Step 3: Bundle to Single HTML File
46
+
47
+ To bundle the React app into a single HTML artifact:
48
+ ```bash
49
+ bash scripts/bundle-artifact.sh
50
+ ```
51
+
52
+ This creates `bundle.html` - a self-contained artifact with all JavaScript, CSS, and dependencies inlined. This file can be directly shared in Claude conversations as an artifact.
53
+
54
+ **Requirements**: Your project must have an `index.html` in the root directory.
55
+
56
+ **What the script does**:
57
+ - Installs bundling dependencies (parcel, @parcel/config-default, parcel-resolver-tspaths, html-inline)
58
+ - Creates `.parcelrc` config with path alias support
59
+ - Builds with Parcel (no source maps)
60
+ - Inlines all assets into single HTML using html-inline
61
+
62
+ ### Step 4: Share Artifact with User
63
+
64
+ Finally, share the bundled HTML file in conversation with the user so they can view it as an artifact.
65
+
66
+ ### Step 5: Testing/Visualizing the Artifact (Optional)
67
+
68
+ Note: This is a completely optional step. Only perform if necessary or requested.
69
+
70
+ To test/visualize the artifact, use available tools (including other Skills or built-in tools like Playwright or Puppeteer). In general, avoid testing the artifact upfront as it adds latency between the request and when the finished artifact can be seen. Test later, after presenting the artifact, if requested or if issues arise.
71
+
72
+ ## Reference
73
+
74
+ - **shadcn/ui components**: https://ui.shadcn.com/docs/components