@musashishao/agent-kit 1.1.5 โ 1.1.6
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.
Potentially problematic release.
This version of @musashishao/agent-kit might be problematic. Click here for more details.
- package/.agent/plans/codex-cli-integration.md +128 -277
- package/.agent/rules/CODEX.md +250 -0
- package/.agent/skills/context-engineering/scripts/quality_validator.py +294 -0
- package/.agent/skills/context-engineering/scripts/skill_checker.py +194 -0
- package/.agent/templates/AGENTS.backend.md +230 -0
- package/.agent/templates/AGENTS.md +121 -0
- package/.agent/templates/AGENTS.mobile.md +183 -0
- package/.agent/templates/AGENTS.web.md +192 -0
- package/.agent/workflows/quality.md +89 -0
- package/.agent/workflows/ui-ux-pro-max.md +19 -0
- package/README.md +172 -44
- package/bin/cli.js +287 -7
- package/package.json +1 -1
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
# AGENTS.md - Web Application
|
|
2
|
+
|
|
3
|
+
> **[PROJECT_NAME]** - Modern web application built with Agent Kit standards.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## ๐ Project Overview
|
|
8
|
+
|
|
9
|
+
[Brief description of your web application]
|
|
10
|
+
|
|
11
|
+
### Tech Stack
|
|
12
|
+
|
|
13
|
+
| Layer | Technology | Version |
|
|
14
|
+
|-------|------------|---------|
|
|
15
|
+
| **Framework** | Next.js (App Router) | 15.x |
|
|
16
|
+
| **UI Library** | React | 19.x |
|
|
17
|
+
| **Language** | TypeScript | 5.x |
|
|
18
|
+
| **Styling** | Tailwind CSS | 4.x |
|
|
19
|
+
| **Database** | PostgreSQL + Prisma | - |
|
|
20
|
+
| **Auth** | NextAuth.js | 5.x |
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## ๐ ๏ธ Setup Commands
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
# Install dependencies
|
|
28
|
+
npm install
|
|
29
|
+
|
|
30
|
+
# Setup database
|
|
31
|
+
npx prisma generate
|
|
32
|
+
npx prisma migrate dev
|
|
33
|
+
|
|
34
|
+
# Start development server
|
|
35
|
+
npm run dev
|
|
36
|
+
|
|
37
|
+
# Build for production
|
|
38
|
+
npm run build
|
|
39
|
+
|
|
40
|
+
# Run linting
|
|
41
|
+
npm run lint
|
|
42
|
+
|
|
43
|
+
# Run tests
|
|
44
|
+
npm test
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## ๐ Code Style & Standards
|
|
50
|
+
|
|
51
|
+
### TypeScript
|
|
52
|
+
- Strict mode enabled
|
|
53
|
+
- No `any` types - use proper typing
|
|
54
|
+
- Interfaces for props, Types for unions
|
|
55
|
+
|
|
56
|
+
### React Patterns
|
|
57
|
+
- Functional components only
|
|
58
|
+
- Custom hooks for logic reuse
|
|
59
|
+
- Server Components by default, "use client" only when needed
|
|
60
|
+
- Composition over inheritance
|
|
61
|
+
|
|
62
|
+
### File Naming
|
|
63
|
+
- Components: `PascalCase.tsx`
|
|
64
|
+
- Utilities: `camelCase.ts`
|
|
65
|
+
- Styles: `kebab-case.css`
|
|
66
|
+
|
|
67
|
+
### Imports
|
|
68
|
+
```typescript
|
|
69
|
+
// Use absolute imports with @/ alias
|
|
70
|
+
import { Button } from "@/components/ui/button";
|
|
71
|
+
import { cn } from "@/lib/utils";
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## ๐ Project Structure
|
|
77
|
+
|
|
78
|
+
```
|
|
79
|
+
src/
|
|
80
|
+
โโโ app/ # Next.js App Router
|
|
81
|
+
โ โโโ (marketing)/ # Marketing pages group
|
|
82
|
+
โ โโโ (dashboard)/ # Dashboard pages group
|
|
83
|
+
โ โโโ api/ # API routes
|
|
84
|
+
โ โโโ layout.tsx # Root layout
|
|
85
|
+
โ โโโ page.tsx # Home page
|
|
86
|
+
โ โโโ globals.css # Global styles
|
|
87
|
+
โ
|
|
88
|
+
โโโ components/
|
|
89
|
+
โ โโโ ui/ # Reusable UI components
|
|
90
|
+
โ โโโ forms/ # Form components
|
|
91
|
+
โ โโโ layout/ # Layout components
|
|
92
|
+
โ
|
|
93
|
+
โโโ lib/
|
|
94
|
+
โ โโโ db.ts # Database client
|
|
95
|
+
โ โโโ auth.ts # Auth configuration
|
|
96
|
+
โ โโโ utils.ts # Utility functions
|
|
97
|
+
โ
|
|
98
|
+
โโโ hooks/ # Custom React hooks
|
|
99
|
+
โโโ types/ # TypeScript types
|
|
100
|
+
โโโ services/ # External service integrations
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## ๐ Security Guidelines
|
|
106
|
+
|
|
107
|
+
### Environment Variables
|
|
108
|
+
```bash
|
|
109
|
+
# Required variables (never commit these)
|
|
110
|
+
DATABASE_URL=
|
|
111
|
+
NEXTAUTH_SECRET=
|
|
112
|
+
NEXTAUTH_URL=
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Best Practices
|
|
116
|
+
- Never hardcode secrets in code
|
|
117
|
+
- Validate all user inputs (server-side)
|
|
118
|
+
- Use CSRF protection for forms
|
|
119
|
+
- Implement rate limiting on API routes
|
|
120
|
+
- External links: `rel="noopener noreferrer"`
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## ๐งช Testing
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
# Unit tests
|
|
128
|
+
npm test
|
|
129
|
+
|
|
130
|
+
# E2E tests with Playwright
|
|
131
|
+
npm run test:e2e
|
|
132
|
+
|
|
133
|
+
# Coverage report
|
|
134
|
+
npm run test:coverage
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Test Structure
|
|
138
|
+
```
|
|
139
|
+
__tests__/
|
|
140
|
+
โโโ unit/ # Unit tests
|
|
141
|
+
โโโ integration/ # Integration tests
|
|
142
|
+
โโโ e2e/ # End-to-end tests
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## ๐ Deployment
|
|
148
|
+
|
|
149
|
+
```bash
|
|
150
|
+
# Production build
|
|
151
|
+
npm run build
|
|
152
|
+
|
|
153
|
+
# Preview production locally
|
|
154
|
+
npm start
|
|
155
|
+
|
|
156
|
+
# Deploy (example: Vercel)
|
|
157
|
+
npx vercel
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
---
|
|
161
|
+
|
|
162
|
+
## ๐ค AI Agent Configuration
|
|
163
|
+
|
|
164
|
+
### Quick Commands
|
|
165
|
+
|
|
166
|
+
| Command | Description |
|
|
167
|
+
|---------|-------------|
|
|
168
|
+
| `/create dashboard` | Create dashboard components |
|
|
169
|
+
| `/debug login issue` | Debug authentication |
|
|
170
|
+
| `/test UserProfile` | Generate tests for component |
|
|
171
|
+
| `/ui-ux-pro-max hero section` | Design premium hero |
|
|
172
|
+
|
|
173
|
+
### Agent Mentions
|
|
174
|
+
|
|
175
|
+
- `@frontend-specialist` - React/Next.js development
|
|
176
|
+
- `@backend-specialist` - API routes, Prisma
|
|
177
|
+
- `@database-architect` - Schema design
|
|
178
|
+
- `@security-auditor` - Security review
|
|
179
|
+
- `@test-engineer` - Test generation
|
|
180
|
+
|
|
181
|
+
---
|
|
182
|
+
|
|
183
|
+
## ๐ Additional Resources
|
|
184
|
+
|
|
185
|
+
- [Next.js Documentation](https://nextjs.org/docs)
|
|
186
|
+
- [React Documentation](https://react.dev)
|
|
187
|
+
- [Tailwind CSS](https://tailwindcss.com/docs)
|
|
188
|
+
- [Prisma Documentation](https://www.prisma.io/docs)
|
|
189
|
+
|
|
190
|
+
---
|
|
191
|
+
|
|
192
|
+
*Built with Agent Kit - AI-enhanced development*
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Optimize context and output quality for Codex CLI. Use for complex tasks requiring high-quality results.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# /quality - Quality Optimization Workflow
|
|
6
|
+
|
|
7
|
+
$ARGUMENTS
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Purpose
|
|
12
|
+
|
|
13
|
+
This workflow optimizes AI output quality by:
|
|
14
|
+
1. Loading relevant skills
|
|
15
|
+
2. Applying context engineering
|
|
16
|
+
3. Ensuring production-ready output
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Steps
|
|
21
|
+
|
|
22
|
+
### Step 1: Analyze Request
|
|
23
|
+
Determine the task type and required skills:
|
|
24
|
+
|
|
25
|
+
| Task Type | Skills to Load |
|
|
26
|
+
|-----------|----------------|
|
|
27
|
+
| Frontend | `react-patterns`, `nextjs-best-practices`, `tailwind-patterns` |
|
|
28
|
+
| Backend | `api-patterns`, `nodejs-best-practices`, `database-design` |
|
|
29
|
+
| Mobile | `mobile-design`, `react-patterns` |
|
|
30
|
+
| Security | `vulnerability-scanner`, `red-team-tactics` |
|
|
31
|
+
| UI/UX | `ui-ux-pro-max`, `frontend-design` |
|
|
32
|
+
| Debug | `systematic-debugging`, `problem-solving` |
|
|
33
|
+
|
|
34
|
+
### Step 2: Load Context
|
|
35
|
+
// turbo
|
|
36
|
+
Read the relevant skill files:
|
|
37
|
+
```
|
|
38
|
+
Read .agent/skills/{skill-name}/SKILL.md
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Step 3: Apply Quality Standards
|
|
42
|
+
Ensure output follows these rules:
|
|
43
|
+
|
|
44
|
+
**Code Quality:**
|
|
45
|
+
- [ ] No placeholder code (`// TODO`)
|
|
46
|
+
- [ ] No generic variable names (`data`, `temp`)
|
|
47
|
+
- [ ] Proper error handling
|
|
48
|
+
- [ ] TypeScript strict types
|
|
49
|
+
- [ ] Clean code principles
|
|
50
|
+
|
|
51
|
+
**Output Format:**
|
|
52
|
+
- [ ] Well-structured markdown
|
|
53
|
+
- [ ] Code blocks with language tags
|
|
54
|
+
- [ ] Clear step-by-step instructions
|
|
55
|
+
- [ ] Actionable recommendations
|
|
56
|
+
|
|
57
|
+
### Step 4: Validate Output
|
|
58
|
+
Before delivering, check:
|
|
59
|
+
|
|
60
|
+
```markdown
|
|
61
|
+
## Quality Checklist
|
|
62
|
+
- [ ] Code compiles without errors
|
|
63
|
+
- [ ] All edge cases handled
|
|
64
|
+
- [ ] Security best practices followed
|
|
65
|
+
- [ ] Performance optimized
|
|
66
|
+
- [ ] Documentation included
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## Usage Examples
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
/quality create a login form
|
|
75
|
+
/quality review this API endpoint
|
|
76
|
+
/quality debug the authentication flow
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## When to Use
|
|
82
|
+
|
|
83
|
+
Use `/quality` when:
|
|
84
|
+
- Building production features
|
|
85
|
+
- Creating code for open source
|
|
86
|
+
- Implementing security-sensitive features
|
|
87
|
+
- Need highest quality output
|
|
88
|
+
|
|
89
|
+
For quick tasks, use direct commands instead.
|
|
@@ -4,6 +4,25 @@ description: Plan and implement UI
|
|
|
4
4
|
|
|
5
5
|
# UI/UX Pro Max - Design Intelligence
|
|
6
6
|
|
|
7
|
+
$ARGUMENTS
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## โ ๏ธ MANDATORY: Before Starting (Socratic Gate)
|
|
12
|
+
|
|
13
|
+
**DO NOT execute any search commands until you understand the user's requirements.**
|
|
14
|
+
|
|
15
|
+
If the user only typed `/ui-ux-pro-max` without additional context, you MUST ask:
|
|
16
|
+
|
|
17
|
+
1. **What are you building?** (landing page, dashboard, e-commerce, SaaS, mobile app, etc.)
|
|
18
|
+
2. **What industry/domain?** (healthcare, fintech, beauty, gaming, education, etc.)
|
|
19
|
+
3. **Any style preferences?** (minimal, dark mode, playful, professional, glassmorphism, etc.)
|
|
20
|
+
4. **What tech stack?** (html-tailwind, React, Next.js, Vue, or other)
|
|
21
|
+
|
|
22
|
+
**Only proceed to Step 1 after receiving answers.**
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
7
26
|
Searchable database of UI styles, color palettes, font pairings, chart types, product recommendations, UX guidelines, and stack-specific best practices.
|
|
8
27
|
|
|
9
28
|
## Prerequisites
|
package/README.md
CHANGED
|
@@ -1,8 +1,13 @@
|
|
|
1
1
|
# Agent Kit
|
|
2
2
|
|
|
3
|
-
> ๐ AI Agent
|
|
3
|
+
> ๐ The Ultimate AI Agent System for Modern Development
|
|
4
|
+
>
|
|
5
|
+
> **16 Agents** โข **42 Skills** โข **13 Workflows** โข **Multi-Platform Support**
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
[](https://www.npmjs.com/package/@musashishao/agent-kit)
|
|
8
|
+
[](https://opensource.org/licenses/MIT)
|
|
9
|
+
|
|
10
|
+
## โก Quick Install
|
|
6
11
|
|
|
7
12
|
```bash
|
|
8
13
|
npx @musashishao/agent-kit init
|
|
@@ -22,20 +27,120 @@ This installs the `.agent` folder containing all templates into your project.
|
|
|
22
27
|
| Component | Count | Description |
|
|
23
28
|
|-----------|-------|-------------|
|
|
24
29
|
| **Agents** | 16 | Specialist AI personas (frontend, backend, security, etc.) |
|
|
25
|
-
| **Skills** |
|
|
26
|
-
| **Workflows** |
|
|
30
|
+
| **Skills** | 42 | Domain-specific knowledge modules |
|
|
31
|
+
| **Workflows** | 13 | Slash command procedures |
|
|
32
|
+
| **Templates** | 4 | Project templates (web, mobile, backend) |
|
|
33
|
+
|
|
34
|
+
## ๐ Multi-Platform Support
|
|
35
|
+
|
|
36
|
+
Agent Kit works seamlessly with multiple AI coding assistants:
|
|
37
|
+
|
|
38
|
+
| Platform | Status | Config File |
|
|
39
|
+
|----------|--------|-------------|
|
|
40
|
+
| **Codex CLI** | โ
Full Support | `AGENTS.md` |
|
|
41
|
+
| **Gemini CLI** | โ
Full Support | `GEMINI.md` |
|
|
42
|
+
| **Cursor** | โ
Compatible | `.cursor/rules` |
|
|
43
|
+
| **Claude Code** | โ
Compatible | `CLAUDE.md` |
|
|
44
|
+
| **Aider** | โ
Compatible | `AGENTS.md` |
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## ๐ฏ Codex CLI Integration
|
|
49
|
+
|
|
50
|
+
### Quick Setup
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
# Step 1: Install Agent Kit
|
|
54
|
+
npx @musashishao/agent-kit init
|
|
55
|
+
|
|
56
|
+
# Step 2: Generate AGENTS.md for your project
|
|
57
|
+
npx @musashishao/agent-kit codex --template web
|
|
58
|
+
|
|
59
|
+
# Step 3: Sync workflows as slash commands
|
|
60
|
+
npx @musashishao/agent-kit setup-codex
|
|
61
|
+
|
|
62
|
+
# Step 4: Verify installation
|
|
63
|
+
npx @musashishao/agent-kit doctor
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Available Templates
|
|
27
67
|
|
|
28
|
-
|
|
68
|
+
| Template | Command | Use Case |
|
|
69
|
+
|----------|---------|----------|
|
|
70
|
+
| **Web** | `codex --template web` | Next.js, React, Tailwind |
|
|
71
|
+
| **Mobile** | `codex --template mobile` | React Native, Flutter |
|
|
72
|
+
| **Backend** | `codex --template backend` | Node.js, Express, APIs |
|
|
73
|
+
| **Default** | `codex` | Generic projects |
|
|
74
|
+
|
|
75
|
+
### Using Workflows in Codex CLI
|
|
76
|
+
|
|
77
|
+
After running `setup-codex`, use Agent Kit workflows as slash commands:
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
# Create new features
|
|
81
|
+
/kit-create blog with authentication
|
|
82
|
+
|
|
83
|
+
# Debug issues
|
|
84
|
+
/kit-debug why login returns 401
|
|
85
|
+
|
|
86
|
+
# Design premium UI
|
|
87
|
+
/kit-ui-ux-pro-max dashboard with glassmorphism
|
|
88
|
+
|
|
89
|
+
# Quality optimization
|
|
90
|
+
/kit-quality create production-ready checkout
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
## ๐ CLI Commands
|
|
96
|
+
|
|
97
|
+
| Command | Description |
|
|
98
|
+
|---------|-------------|
|
|
99
|
+
| `init` | Install `.agent` folder into your project |
|
|
100
|
+
| `codex` | Generate AGENTS.md for Codex CLI |
|
|
101
|
+
| `setup-codex` | Sync workflows with Codex CLI slash commands |
|
|
102
|
+
| `agents` | List all available agents |
|
|
103
|
+
| `skills` | List all skills by category |
|
|
104
|
+
| `workflows` | List all workflows |
|
|
105
|
+
| `doctor` | Health check and diagnostics |
|
|
106
|
+
| `update` | Update to the latest version |
|
|
107
|
+
| `status` | Check installation status |
|
|
108
|
+
|
|
109
|
+
### Options
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
# Codex template options
|
|
113
|
+
agent-kit codex --template web # Web application
|
|
114
|
+
agent-kit codex --template mobile # Mobile app
|
|
115
|
+
agent-kit codex --template backend # Backend API
|
|
116
|
+
agent-kit codex --force # Overwrite existing
|
|
117
|
+
|
|
118
|
+
# Init options
|
|
119
|
+
agent-kit init --force # Overwrite existing .agent folder
|
|
120
|
+
agent-kit init --path ./myapp # Install in specific directory
|
|
121
|
+
|
|
122
|
+
# Setup-codex options
|
|
123
|
+
agent-kit setup-codex --prefix my- # Custom prefix for slash commands
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
## ๐ Project Structure
|
|
29
129
|
|
|
30
130
|
```
|
|
31
131
|
.agent/
|
|
32
132
|
โโโ agents/ # 16 Specialist Agents
|
|
33
|
-
โโโ skills/ #
|
|
34
|
-
โโโ workflows/ #
|
|
35
|
-
โโโ rules/ #
|
|
133
|
+
โโโ skills/ # 42 Skills
|
|
134
|
+
โโโ workflows/ # 13 Slash Commands
|
|
135
|
+
โโโ rules/ # Platform-specific rules
|
|
136
|
+
โ โโโ CODEX.md # Codex CLI rules
|
|
137
|
+
โ โโโ GEMINI.md # Gemini CLI rules
|
|
138
|
+
โโโ templates/ # Project templates
|
|
36
139
|
โโโ ARCHITECTURE.md # Full documentation
|
|
37
140
|
```
|
|
38
141
|
|
|
142
|
+
---
|
|
143
|
+
|
|
39
144
|
## ๐ฏ Usage
|
|
40
145
|
|
|
41
146
|
### Using Agents
|
|
@@ -43,8 +148,9 @@ This installs the `.agent` folder containing all templates into your project.
|
|
|
43
148
|
Mention an agent by name to invoke specialized expertise:
|
|
44
149
|
|
|
45
150
|
```
|
|
46
|
-
Use the security-auditor
|
|
47
|
-
Use the frontend-specialist to analyze React components
|
|
151
|
+
Use the @security-auditor to review authentication
|
|
152
|
+
Use the @frontend-specialist to analyze React components
|
|
153
|
+
Use the @debugger to fix the login issue
|
|
48
154
|
```
|
|
49
155
|
|
|
50
156
|
### Using Skills
|
|
@@ -65,8 +171,10 @@ Invoke workflows with slash commands:
|
|
|
65
171
|
| `/orchestrate` | Multi-agent coordination |
|
|
66
172
|
| `/plan` | Create task breakdown |
|
|
67
173
|
| `/preview` | Preview changes locally |
|
|
174
|
+
| `/quality` | **NEW** Optimize output quality |
|
|
68
175
|
| `/status` | Check project status |
|
|
69
176
|
| `/test` | Generate and run tests |
|
|
177
|
+
| `/context` | Context optimization |
|
|
70
178
|
| `/ui-ux-pro-max` | Design with 50 styles |
|
|
71
179
|
|
|
72
180
|
Example:
|
|
@@ -74,60 +182,80 @@ Example:
|
|
|
74
182
|
/brainstorm authentication system
|
|
75
183
|
/create landing page with hero section
|
|
76
184
|
/debug why login fails
|
|
185
|
+
/quality create production-ready API
|
|
77
186
|
```
|
|
78
187
|
|
|
79
|
-
|
|
188
|
+
---
|
|
80
189
|
|
|
81
|
-
|
|
190
|
+
## ๐ Platform Setup Guides
|
|
82
191
|
|
|
83
|
-
|
|
192
|
+
### Gemini CLI
|
|
84
193
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
| `agent-kit setup-codex` | Sync workflows with Codex CLI slash commands |
|
|
89
|
-
| `agent-kit update` | Update to the latest version |
|
|
90
|
-
| `agent-kit status` | Check installation status |
|
|
194
|
+
```bash
|
|
195
|
+
# Install Agent Kit
|
|
196
|
+
npx @musashishao/agent-kit init
|
|
91
197
|
|
|
92
|
-
|
|
198
|
+
# Configure Gemini settings
|
|
199
|
+
echo '{ "contextFileName": ".agent/rules/GEMINI.md" }' > .gemini/settings.json
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### Cursor IDE
|
|
93
203
|
|
|
94
204
|
```bash
|
|
95
|
-
|
|
96
|
-
agent-kit init
|
|
97
|
-
|
|
98
|
-
|
|
205
|
+
# Install Agent Kit
|
|
206
|
+
npx @musashishao/agent-kit init
|
|
207
|
+
|
|
208
|
+
# Copy rules to Cursor
|
|
209
|
+
mkdir -p .cursor/rules
|
|
210
|
+
cp .agent/rules/GEMINI.md .cursor/rules/agent-kit.md
|
|
99
211
|
```
|
|
100
212
|
|
|
101
|
-
|
|
213
|
+
### Claude Code
|
|
102
214
|
|
|
103
|
-
|
|
215
|
+
```bash
|
|
216
|
+
# Install Agent Kit
|
|
217
|
+
npx @musashishao/agent-kit init
|
|
218
|
+
|
|
219
|
+
# Copy rules for Claude
|
|
220
|
+
cp .agent/rules/GEMINI.md CLAUDE.md
|
|
221
|
+
```
|
|
104
222
|
|
|
105
|
-
|
|
106
|
-
|----------|--------|-------|
|
|
107
|
-
| **Codex CLI** | `AGENTS.md` | `npx @musashishao/agent-kit setup-codex` |
|
|
108
|
-
| **Gemini CLI** | `.gemini/settings.json` | `{ "contextFileName": ".agent/rules/GEMINI.md" }` |
|
|
109
|
-
| **Cursor** | `.cursor/rules` | Copy from `.agent/rules/` |
|
|
110
|
-
| **Aider** | `.aider.conf.yml` | `read: AGENTS.md` |
|
|
223
|
+
---
|
|
111
224
|
|
|
112
|
-
|
|
225
|
+
## ๐ Quality Validation
|
|
113
226
|
|
|
114
|
-
|
|
227
|
+
Ensure your setup is optimal:
|
|
115
228
|
|
|
116
229
|
```bash
|
|
117
|
-
#
|
|
118
|
-
npx @musashishao/agent-kit
|
|
230
|
+
# Run health check
|
|
231
|
+
npx @musashishao/agent-kit doctor
|
|
119
232
|
|
|
120
|
-
#
|
|
121
|
-
|
|
233
|
+
# Run quality validator
|
|
234
|
+
python3 .agent/skills/context-engineering/scripts/quality_validator.py .
|
|
122
235
|
```
|
|
123
236
|
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
237
|
+
Expected output:
|
|
238
|
+
```
|
|
239
|
+
๐ Summary
|
|
240
|
+
Passed: 32/32 (100%)
|
|
241
|
+
โ Excellent! Agent Kit is fully configured for Codex CLI.
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
---
|
|
245
|
+
|
|
246
|
+
## ๐ Documentation
|
|
247
|
+
|
|
248
|
+
- **Website**: [agent-kit.musashi.works](https://agent-kit.musashi.works)
|
|
249
|
+
- **AGENTS.md**: Project root
|
|
250
|
+
- **ARCHITECTURE.md**: `.agent/ARCHITECTURE.md`
|
|
251
|
+
- **Platform Guides**: `/docs/platforms/`
|
|
252
|
+
|
|
253
|
+
---
|
|
254
|
+
|
|
255
|
+
## ๐ค Contributing
|
|
256
|
+
|
|
257
|
+
We welcome contributions! Please see `.agent/ARCHITECTURE.md` for guidelines.
|
|
129
258
|
|
|
130
259
|
## License
|
|
131
260
|
|
|
132
261
|
MIT ยฉ Musa (musashishao)
|
|
133
|
-
|