@qubiit/lmagent 3.1.1 → 3.1.3

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.
Files changed (46) hide show
  1. package/.agents/docs/commands.md +80 -31
  2. package/.agents/docs/getting-started.md +50 -46
  3. package/.agents/rules/00-master.md +2 -2
  4. package/.agents/skills/ai-agent-engineer/SKILL.md +15 -3
  5. package/.agents/skills/api-designer/SKILL.md +13 -3
  6. package/.agents/skills/architect/SKILL.md +42 -29
  7. package/.agents/skills/automation-engineer/SKILL.md +14 -3
  8. package/.agents/skills/backend-engineer/SKILL.md +17 -3
  9. package/.agents/skills/bmad-methodology/SKILL.md +12 -3
  10. package/.agents/skills/browser-agent/SKILL.md +12 -3
  11. package/.agents/skills/code-reviewer/SKILL.md +13 -3
  12. package/.agents/skills/data-engineer/SKILL.md +14 -3
  13. package/.agents/skills/devops-engineer/SKILL.md +14 -3
  14. package/.agents/skills/document-generator/SKILL.md +14 -3
  15. package/.agents/skills/frontend-engineer/SKILL.md +19 -3
  16. package/.agents/skills/git-workflow/SKILL.md +12 -3
  17. package/.agents/skills/mcp-builder/SKILL.md +14 -3
  18. package/.agents/skills/mobile-engineer/SKILL.md +14 -3
  19. package/.agents/skills/orchestrator/SKILL.md +14 -3
  20. package/.agents/skills/performance-engineer/SKILL.md +14 -3
  21. package/.agents/skills/product-manager/SKILL.md +14 -3
  22. package/.agents/skills/prompt-engineer/SKILL.md +12 -3
  23. package/.agents/skills/qa-engineer/SKILL.md +14 -3
  24. package/.agents/skills/scrum-master/SKILL.md +12 -3
  25. package/.agents/skills/security-analyst/SKILL.md +14 -3
  26. package/.agents/skills/seo-auditor/SKILL.md +13 -3
  27. package/.agents/skills/spec-driven-dev/SKILL.md +14 -3
  28. package/.agents/skills/supabase-expert/SKILL.md +14 -3
  29. package/.agents/skills/swe-agent/SKILL.md +16 -3
  30. package/.agents/skills/systematic-debugger/SKILL.md +13 -3
  31. package/.agents/skills/tech-lead/SKILL.md +14 -3
  32. package/.agents/skills/technical-writer/SKILL.md +14 -3
  33. package/.agents/skills/testing-strategist/SKILL.md +13 -3
  34. package/.agents/skills/ux-ui-designer/SKILL.md +14 -3
  35. package/.agents/templates/agent-configs/_generic.md +20 -0
  36. package/.agents/templates/agent-configs/continuerules.md +17 -0
  37. package/.agents/templates/agent-configs/goosehints.md +19 -0
  38. package/.agents/templates/agent-configs/junie-guidelines.md +22 -0
  39. package/.agents/templates/agent-configs/openclaw.json +17 -0
  40. package/.agents/templates/agent-configs/openhands-repo.md +21 -0
  41. package/AGENTS.md +171 -85
  42. package/CLAUDE.md +2 -2
  43. package/CONTRIBUTING.md +112 -49
  44. package/README.md +211 -242
  45. package/install.js +423 -363
  46. package/package.json +1 -1
package/README.md CHANGED
@@ -3,295 +3,267 @@
3
3
  ```text
4
4
  ██╗ ███╗ ███╗ █████╗ ██████╗ ███████╗███╗ ██╗████████╗
5
5
  ██║ ████╗ ████║██╔══██╗██╔════╝ ██╔════╝████╗ ██║╚══██╔══╝
6
- ██║ ██╔████╔██║███████║██║ ███╗█████╗ ██╔██╗ ██║ ██║
7
- ██║ ██║╚██╔╝██║██╔══██║██║ ██║██╔══╝ ██║╚██╗██║ ██║
8
- ███████╗██║ ╚═╝ ██║██║ ██║╚██████╔╝███████╗██║ ╚████║ ██║
9
- ╚══════╝╚╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝ ╚══════╝╚═╝ ╚═══╝ ╚═╝
6
+ ██║ ██╔████╔██║███████║██║ ███╗█████╗ ██╔██╗ ██║ ██║
7
+ ██║ ██║╚██╔╝██║██╔══██║██║ ██║██╔══╝ ██║╚██╗██║ ██║
8
+ ███████╗██║ ╚═╝ ██║██║ ██║╚██████╔╝███████╗██║ ╚████║ ██║
9
+ ╚══════╝╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝ ╚══════╝╚═╝ ╚═══╝ ╚═╝
10
10
  by QuBit
11
11
  ```
12
12
 
13
- ![Version](https://img.shields.io/badge/version-3.1.1-blue.svg) ![License](https://img.shields.io/badge/License-MIT-green?style=for-the-badge) ![Agentic](https://img.shields.io/badge/AI-Agentic_Workflow-cyan?style=for-the-badge)
13
+ ![Version](https://img.shields.io/badge/version-3.1.3-blue.svg) ![License](https://img.shields.io/badge/License-MIT-green?style=for-the-badge) ![Agents](https://img.shields.io/badge/Agents-37_Supported-cyan?style=for-the-badge) ![Skills](https://img.shields.io/badge/Skills-31_Available-purple?style=for-the-badge)
14
14
 
15
- > **"Separate the reasoning from the execution."**
16
- > LMAgent is the foundational runtime that empowers your AI Agents with standardized **Skills**, **Rules**, and **Workflows** across any IDE (Cursor, Windsurf, VSCode, Zed, Qodo).
15
+ > **"Separate the reasoning from the execution."**
16
+ > LMAgent is the foundational runtime that empowers your AI Agents with standardized **Skills**, **Rules**, and **Workflows** across **37 supported agents** (Cursor, Claude Code, Windsurf, Gemini CLI, Cline, Roo, Copilot, and many more).
17
17
 
18
18
  ---
19
19
 
20
- ## 🚀 Quick Start Guide
21
-
22
- The recommended way to use LMAgent is via `npx`, ensuring you always run the latest version without managing global packages.
23
-
24
- ### ⚡ Instant Run (No Install)
25
- Run these commands directly in your terminal:
20
+ ## One Command. Any Agent.
26
21
 
27
22
  ```bash
28
- # 1. Initialize Project (Context)
29
- # Copies AGENTS.md & CLAUDE.md to your root.
30
- npx lmagent init
23
+ npx lmagent@latest
24
+ ```
31
25
 
32
- # 2. Install/Update Skills (Tools)
33
- # Configures your IDE (.cursor, .vscode, .windsurf, etc.)
34
- npx lmagent install
26
+ That's it. No global install required. LMAgent will:
27
+ 1. **Auto-detect** which AI agents you have installed on your system
28
+ 2. **Pre-select** the detected agents for installation
29
+ 3. **Deploy** skills, rules, and workflows to each agent's directory
30
+ 4. **Generate** the entry point file so each agent auto-invokes the framework
35
31
 
36
- # 3. Optimize & Verify
37
- # Checks your environment health.
38
- npx lmagent doctor
39
- ```
32
+ > **Requires Node.js 22**. Works on macOS, Linux, and Windows.
40
33
 
41
- ### 📦 Global Installation (Optional)
42
- If you prefer having the `lmagent` command available globally:
34
+ ---
35
+
36
+ ## 🚀 Full Setup Guide
43
37
 
38
+ ### Step 1 — Initialize your project (first time only)
44
39
  ```bash
45
- # Install
46
- npm install -g @qubiit/lmagent
40
+ npx lmagent@latest init
41
+ ```
42
+ Copies `AGENTS.md`, `CLAUDE.md`, and `GEMINI.md` to your project root. These are the entry points that agents read automatically when they start.
47
43
 
48
- # Run
49
- lmagent init
50
- lmagent install
44
+ ### Step 2 — Install the framework
45
+ ```bash
46
+ npx lmagent@latest install
51
47
  ```
48
+ Deploys skills, rules, and workflows to all detected agents. Generates agent-specific config files.
52
49
 
53
- ### 🛠️ Developer Setup
54
- If you are contributing to the framework:
50
+ ### Step 3 — Verify
51
+ ```bash
52
+ npx lmagent@latest doctor
53
+ ```
54
+ Checks that everything is correctly configured.
55
55
 
56
+ ### Update (when new versions are released)
56
57
  ```bash
57
- git clone https://github.com/QuBit/lmagent.git
58
- cd lmagent
59
- npm install
60
- npm link
61
- lmagent doctor
58
+ npx lmagent@latest update
62
59
  ```
63
60
 
64
61
  ---
65
62
 
66
- ## 🏛️ Architecture: Global Brain vs. Local Project
63
+ ## 🏛️ Architecture
67
64
 
68
- LMAgent uses a **Hybrid Architecture** to balance **Centralized Updates** with **Project Portability**.
65
+ LMAgent uses a **Hub & Spoke** model: one universal brain (`.agents/`) that feeds all agents.
69
66
 
70
- ### The Problem it Solves
71
- * **Global Installs** run the risk of breaking projects if they rely on your specific machine paths.
72
- * **Local Copies** become stale and are hard to update across 10+ projects.
67
+ ```text
68
+ Your Project/
69
+ ├── .agents/ # UNIVERSAL BRAIN (source of truth)
70
+ │ ├── rules/ # 11 behavioral rules
71
+ │ ├── skills/ # 31 specialized roles
72
+ │ ├── workflows/ # 13 SOPs (Standard Operating Procedures)
73
+ │ ├── memory/ # 5 persistent context files
74
+ │ ├── templates/ # Project scaffolds & agent config templates
75
+ │ ├── scripts/ # Utility scripts
76
+ │ ├── config/ # Framework settings
77
+ │ └── docs/ # Extended documentation
78
+
79
+ ├── AGENTS.md # ← PILLAR 1: Capability catalog (read by all agents)
80
+ ├── CLAUDE.md # ← PILLAR 2: Entry point for Claude Code / Antigravity
81
+ ├── GEMINI.md # ← PILLAR 3: Entry point for Gemini CLI / Antigravity
82
+
83
+ ├── .cursor/rules/ # ← Cursor-specific rules & skills
84
+ ├── .windsurf/rules/ # ← Windsurf-specific rules & skills
85
+ ├── .claude/rules/ # ← Claude Code-specific rules & skills
86
+ └── ... # (one directory per installed agent)
87
+ ```
73
88
 
74
- ### The Solution: "Symlink Bridge"
89
+ ### How auto-invocation works
75
90
 
76
- | Layer | Location | Purpose |
77
- | :--- | :--- | :--- |
78
- | **1. Global Brain** | `~/.agents/` | **Single Source of Truth**. Hosted in your user home. Updated via `npm update -g`. |
79
- | **2. Local Project** | `./.cursor/skills/` | **Symlinks** pointing to the Global Brain. Lightweight and bridge-like. |
80
- | **3. Context** | `./CLAUDE.md` | Points to **Local Symlinks** (Relative Paths). **100% Portable** to other devs. |
91
+ Each agent reads a specific file when it starts. LMAgent generates that file automatically:
81
92
 
82
- ### Why `init` and `install` are separate?
83
- 1. **`lmagent init`**: Creates the **Portable Structure** (files that *must* exist in the repo to work, like `CLAUDE.md`).
84
- 2. **`lmagent install`**: Builds the **Bridge** (Symlinks) specific to *your* machine's environment.
93
+ | Agent | Entry Point Generated |
94
+ |:---|:---|
95
+ | Cursor | `.cursorrules` |
96
+ | Claude Code | `CLAUDE.md` |
97
+ | Gemini CLI / Antigravity | `GEMINI.md` |
98
+ | Windsurf | `.windsurf/rules/lmagent.md` |
99
+ | Cline | `.clinerules/00-lmagent.md` |
100
+ | Roo Code | `.roo/rules/00-lmagent.md` |
101
+ | VSCode Copilot | `.github/copilot-instructions.md` |
102
+ | Goose | `.goosehints` |
103
+ | Continue | `.continuerules` |
104
+ | Junie | `.junie/guidelines.md` |
105
+ | OpenHands | `.openhands/microagents/repo.md` |
106
+ | Codex CLI | `AGENTS.md` |
107
+ | All others | `00-lmagent.md` in their `rulesDir` |
85
108
 
86
- > **Best Practice**: Commit `CLAUDE.md` and `AGENTS.md`. **Do NOT** commit the `.cursor/skills` folder (add it to `.gitignore`), as each developer should run `lmagent install` to link their own brain.
109
+ All entry points point to `AGENTS.md` the single source of truth.
87
110
 
88
111
  ---
89
112
 
90
- ## 🛠️ Creating New Skills
91
- Need a custom agent? Use the interactive generator:
113
+ ## 🧩 Skills Catalog (31 Skills)
114
+
115
+ Activate any skill by typing its trigger in the chat:
116
+
117
+ ### 🎯 Management & Architecture
118
+ | Trigger | Skill | Description |
119
+ |:---|:---|:---|
120
+ | `/orch` | **orchestrator** | High-level task planning and agent coordination |
121
+ | `/pm` | **product-manager** | PRD generation, user stories, roadmap planning |
122
+ | `/arch` | **architect** | System design, scalable patterns, cloud infrastructure |
123
+ | `/lead` | **tech-lead** | Code review, technical decisions, mentoring |
124
+ | `/sm` | **scrum-master** | Agile ceremonies, sprint planning, retrospectives |
125
+ | `/doc` | **technical-writer** | Documentation, API refs, user guides |
126
+
127
+ ### 🔧 Engineering
128
+ | Trigger | Skill | Description |
129
+ |:---|:---|:---|
130
+ | `/dev` | **backend-engineer** | APIs, database schema, authentication |
131
+ | `/front` | **frontend-engineer** | React, Next.js, Tailwind, state management |
132
+ | `/mobile` | **mobile-engineer** | React Native, Expo, iOS/Android pipelines |
133
+ | `/data` | **data-engineer** | ETL pipelines, SQL optimization, data warehousing |
134
+ | `/devops` | **devops-engineer** | CI/CD, Docker, Kubernetes, Terraform |
135
+ | `/sec` | **security-analyst** | Vulnerability scanning, OWASP, code auditing |
136
+ | `/test` | **qa-engineer** | E2E testing (Playwright), unit tests, QA strategy |
137
+ | `/review` | **code-reviewer** | Static analysis, logic verification, clean code |
138
+ | `/api` | **api-designer** | REST/GraphQL contracts, OpenAPI standards |
139
+ | `/supa` | **supabase-expert** | Supabase architecture, RLS, Edge Functions |
140
+ | `/git` | **git-workflow** | Branch management, conventional commits, releases |
141
+ | `/web` | **browser-agent** | Web automation, scraping, UI testing |
142
+ | `/seo` | **seo-auditor** | Technical SEO, Core Web Vitals, accessibility |
143
+
144
+ ### ⚡ Specialized & AI
145
+ | Trigger | Skill | Description |
146
+ |:---|:---|:---|
147
+ | `/fix` | **systematic-debugger** | Methodical 4-phase debugging (RCA) |
148
+ | `/perf` | **performance-engineer** | Profiling, load testing, optimization |
149
+ | `/ux` | **ux-ui-designer** | Design systems, user flow, prototyping |
150
+ | `/agent` | **ai-agent-engineer** | Building LLM-based systems & MCP servers |
151
+ | `/auto` | **automation-engineer** | n8n workflows, Zapier, scripting |
152
+ | `/prompt` | **prompt-engineer** | Optimizing system prompts and LLM interactions |
153
+ | `/mcp` | **mcp-builder** | Build MCP servers, tools, and resources |
154
+ | `/pdf` | **document-generator** | Programmatic PDF/DOCX/XLSX generation |
155
+
156
+ ### 🧠 Methodologies
157
+ | Trigger | Skill | Description |
158
+ |:---|:---|:---|
159
+ | `/bmad` | **bmad-methodology** | Scale-Adaptive Intelligence, complexity classification |
160
+ | `/sdd` | **spec-driven-dev** | Spec-first development pipeline |
161
+ | `/swe` | **swe-agent** | Autonomous issue resolution, trajectory logging |
162
+ | `/test-s` | **testing-strategist** | Test planning, pyramid strategy, coverage goals |
92
163
 
93
- ```bash
94
- # Verify structure of existing skills
95
- npx lmagent validate
164
+ ---
96
165
 
97
- # Create a new skill interactively
98
- npx lmagent create-skill
99
- ```
100
- This will generate the standard directory structure and `SKILL.md` template for you.
166
+ ## 🌍 37 Supported Agents
167
+
168
+ | Agent | Config Path | Entry Point |
169
+ |:---|:---|:---|
170
+ | **Cursor** | `.cursor/` | `.cursorrules` |
171
+ | **Windsurf** | `.windsurf/` | `.windsurf/rules/lmagent.md` |
172
+ | **Cline** | `.clinerules/` | `.clinerules/00-lmagent.md` |
173
+ | **Roo Code** | `.roo/` | `.roo/rules/00-lmagent.md` |
174
+ | **VSCode Copilot** | `.github/` | `.github/copilot-instructions.md` |
175
+ | **Trae** | `.trae/` | `.trae/rules/lmagent.md` |
176
+ | **Trae CN** | `.trae-cn/` | `.trae-cn/rules/lmagent.md` |
177
+ | **Claude Code** | `.claude/` | `CLAUDE.md` |
178
+ | **Zed** | `.rules/` | `.rules/lmagent.md` |
179
+ | **Amp / Kimi / Replit** | `.agents/` | `.agents/rules/00-lmagent.md` |
180
+ | **Antigravity** | `.agent/` | `GEMINI.md` |
181
+ | **Augment** | `.augment/` | `.augment/rules/00-lmagent.md` |
182
+ | **Gemini CLI** | `.gemini/` | `GEMINI.md` |
183
+ | **OpenClaw / Envoid** | `rules/` | `openclaw.json` |
184
+ | **CodeBuddy** | `.codebuddy/` | `.codebuddy/rules/00-lmagent.md` |
185
+ | **Codex CLI** | `.codex/` | `AGENTS.md` |
186
+ | **Command Code** | `.commandcode/` | `.commandcode/rules/00-lmagent.md` |
187
+ | **Continue** | `.continue/` | `.continuerules` |
188
+ | **Crush** | `.crush/` | `.crush/rules/00-lmagent.md` |
189
+ | **Droid** | `.factory/` | `.factory/rules/00-lmagent.md` |
190
+ | **Goose** | `.goose/` | `.goosehints` |
191
+ | **Junie** | `.junie/` | `.junie/guidelines.md` |
192
+ | **iFlow CLI** | `.iflow/` | `.iflow/rules/00-lmagent.md` |
193
+ | **Kilo Code** | `.kilocode/` | `.kilocode/rules/00-lmagent.md` |
194
+ | **Kiro CLI** | `.kiro/` | `.kiro/rules/00-lmagent.md` |
195
+ | **Kode** | `.kode/` | `.kode/rules/00-lmagent.md` |
196
+ | **MCPJam** | `.mcpjam/` | `.mcpjam/rules/00-lmagent.md` |
197
+ | **Mistral Vibe** | `.vibe/` | `.vibe/rules/00-lmagent.md` |
198
+ | **Mux** | `.mux/` | `.mux/rules/00-lmagent.md` |
199
+ | **OpenCode** | `.opencode/` | `.opencode/rules/00-lmagent.md` |
200
+ | **OpenHands** | `.openhands/` | `.openhands/microagents/repo.md` |
201
+ | **Pi** | `.pi/` | `.pi/rules/00-lmagent.md` |
202
+ | **Qoder** | `.qoder/` | `.qoder/rules/00-lmagent.md` |
203
+ | **Qwen Code** | `.qwen/` | `.qwen/rules/00-lmagent.md` |
204
+ | **Zencoder** | `.zencoder/` | `.zencoder/rules/00-lmagent.md` |
205
+ | **Neovate** | `.neovate/` | `.neovate/rules/00-lmagent.md` |
206
+ | **Pochi** | `.pochi/` | `.pochi/rules/00-lmagent.md` |
207
+ | **AdaL** | `.adal/` | `.adal/rules/00-lmagent.md` |
101
208
 
102
209
  ---
103
210
 
104
211
  ## 🛠️ CLI Reference
105
212
 
106
- LMAgent includes a powerful CLI to manage your AI context.
107
-
108
- | Command | Usage | Description |
109
- | :--- | :--- | :--- |
110
- | **`init`** | `npx lmagent init` | Initializes the project. Copies `AGENTS.md` (catalog) and `CLAUDE.md` to your root. |
111
- | **`install`** | `npx lmagent install` | **Core Command**. This command will deploy the **Universal Intelligence** (`.agents/`) folder and the core pillars (`AGENTS.md`, `CLAUDE.md`) to your project root. |
112
- | **`update`** | `npx lmagent update` | Alias for `install`. Use this to refresh your skills when new versions are released. |
113
- | **`doctor`** | `npx lmagent doctor` | Verifies your environment, checking for correct file structures using `validate_skills` logic. |
114
- | **`validate`** | `npx lmagent validate` | Scans all `SKILL.md` files for syntax errors or missing required fields. |
115
- | **`create-skill`** | `npx lmagent create-skill` | Interactive wizard to generate a new Skill structure best practices. |
213
+ ```bash
214
+ # Core
215
+ npx lmagent@latest # Interactive install (auto-detects agents)
216
+ npx lmagent@latest init # Initialize project (copies AGENTS.md, CLAUDE.md, GEMINI.md)
217
+ npx lmagent@latest install # Install/update framework in current project
218
+ npx lmagent@latest update # Alias for install
219
+ npx lmagent@latest uninstall # Remove all LMAgent files from project
220
+ npx lmagent@latest uninstall --all # Also remove root entry points (CLAUDE.md, etc.)
221
+
222
+ # Diagnostics
223
+ npx lmagent@latest doctor # Verify project configuration
224
+ npx lmagent@latest validate # Validate integrity of all skills
225
+ npx lmagent@latest tokens # Analyze framework token consumption
226
+
227
+ # Skills Management
228
+ npx lmagent@latest create-skill # Create a new skill interactively
229
+ npx lmagent@latest skills add owner/repo # Install external skill from GitHub
230
+ ```
116
231
 
117
232
  ---
118
233
 
119
- ## 📂 Universal Project Structure
234
+ ## 🛠️ Creating Custom Skills
120
235
 
121
- When you install **LMAgent** in your project, it creates a pristine environment:
236
+ ```bash
237
+ # Create a new skill interactively
238
+ npx lmagent@latest create-skill
122
239
 
123
- ```text
124
- /
125
- ├── .agents/ # [UNIVERSAL BRAIN]
126
- │ ├── rules/ # Core Behavior (00-master, personality, etc.)
127
- │ ├── skills/ # Capabilities (backend-engineer, etc.)
128
- │ ├── workflows/ # Procedures (SOPs)
129
- │ ├── templates/ # Project scaffolds
130
- │ ├── memory/ # Documentation & Logs
131
- │ ├── scripts/ # Utility scripts
132
- │ └── config/ # Global settings
133
-
134
- ├── AGENTS.md # [PILLAR 1] Capability Catalog (Root)
135
- ├── CLAUDE.md # [PILLAR 2] Context & Instructions (Root)
136
-
137
- └── package.json
240
+ # Install an external skill from GitHub
241
+ npx lmagent@latest skills add owner/repo-name
242
+
243
+ # Validate all skills
244
+ npx lmagent@latest validate
138
245
  ```
139
246
 
140
- ### 🧠 The Two Pillars
141
- 1. **AGENTS.md**: The catalog of all capabilities. It tells the agent *what* it can do and *where* to find instructions.
142
- 2. **CLAUDE.md**: The context file. It tells the agent *how* to behave and points to the Master Rule in `.agents/rules/00-master.md`.
247
+ Skills follow the standard structure:
248
+ ```text
249
+ .agents/skills/my-skill/
250
+ ├── SKILL.md # Main instructions (required)
251
+ └── ... # Optional additional files
252
+ ```
143
253
 
144
254
  ---
145
255
 
146
- ## 🏛️ The 3-Pillar Architecture
147
-
148
- LMAgent organizes AI capabilities into three distinct pillars, enforcing a clear separation of concerns.
149
-
150
- ```mermaid
151
- graph TD
152
- A["🤖 AI Agent"] --> B("🛠️ Skills")
153
- A --> C("📜 Rules")
154
- A --> D("⚡ Workflows")
155
-
156
- B --> B1["{ide}/skills/"]
157
- B --> B2["Executable Tools & Scripts"]
158
-
159
- C --> C1["{ide}/rules/"]
160
- C --> C2["Behavioral Guardrails & Context"]
161
-
162
- D --> D1["{ide}/workflows/"]
163
- D --> D2["Standard Operating Procedures (SOPs)"]
164
- ```
165
-
166
- ### 1. 🛠️ Skills (Capabilities)
167
- *Executable units that allow the Agent to interact with the world.*
168
- **Location:** `{ide}/skills/` or `~/.agents/skills/`
169
-
170
- | Skill Name | Description | Tools Included |
171
- | :--- | :--- | :--- |
172
- | **ai-agent-engineer** | Expert in building LLM-based systems & MCP servers. | `create-agent`, `scaffold-mcp` |
173
- | **api-designer** | Design REST/GraphQL contracts, OpenAPI standards. | `scaffold-api`, `lint-openapi` |
174
- | **architect** | System design, scalable patterns, cloud infrastructure. | `design-system`, `review-architecture` |
175
- | **automation-engineer** | n8n workflows, Zapier integration, scripting. | `deploy-n8n`, `check-webhook` |
176
- | **backend-engineer** | API design, Database schema, Authentication. | `scaffold-api`, `optimize-query` |
177
- | **bmad-methodology** | Scale-Adaptive Intelligence, project kickoff, complexity classification. | `classify-level`, `kickoff-project` |
178
- | **browser-agent** | Web automation, scraping, UI testing with Playwright. | `scrape-site`, `automate-flow` |
179
- | **code-reviewer** | Static analysis, logic verification, clean code standards. | `review-pr`, `analyze-complexity` |
180
- | **data-engineer** | ETL pipelines, SQL optimization, Data warehousing. | `analyze-schema`, `run-migration` |
181
- | **devops-engineer** | CI/CD, Docker, Kubernetes, Terraform. | `docker-build`, `k8s-deploy` |
182
- | **document-generator** | Programmatic PDF/DOCX/XLSX generation. | `gen-pdf`, `gen-report` |
183
- | **frontend-engineer** | React, Next.js, Tailwind, State Management. | `scaffold-component`, `check-accessibility` |
184
- | **git-workflow** | Branch management, conventional commits, release flow. | `feature-start`, `release-prep` |
185
- | **mcp-builder** | Build MCP servers, tools, and resources. | `new-mcp-server`, `test-tool` |
186
- | **mobile-engineer** | React Native, Expo, iOS/Android build pipelines. | `build-ios`, `debug-android` |
187
- | **orchestrator** | High-level task planning and agent coordination. | `plan-task`, `delegate-subtask` |
188
- | **performance-engineer** | Profiling, load testing, optimization. | `run-lighthouse`, `profile-memory` |
189
- | **product-manager** | PRD generation, user stories, roadmap planning. | `generate-user-story`, `prioritize-backlog` |
190
- | **prompt-engineer** | Optimizing system prompts and LLM interactions. | `optimize-prompt`, `eval-prompt` |
191
- | **qa-engineer** | E2E testing (Playwright), Unit tests, QA strategy. | `run-playwright`, `generate-test-plan` |
192
- | **scrum-master** | Agile ceremonies, sprint planning, retrospective. | `start-sprint`, `generate-retro` |
193
- | **security-analyst** | Vulnerability scanning, code auditing, OWASP. | `scan-vulnerabilities`, `audit-code` |
194
- | **seo-auditor** | Technical SEO, Core Web Vitals, accessibility audit. | `audit-seo`, `check-meta` |
195
- | **spec-driven-dev** | Spec-first development pipeline: SPECIFY → PLAN → TASKS → IMPLEMENT → VERIFY. | `create-spec`, `validate-spec` |
196
- | **supabase-expert** | Supabase architecture, RLS, Edge Functions. | `init-supabase`, `deploy-edge` |
197
- | **swe-agent** | Autonomous issue resolution, trajectory logging, Edit-Lint-Test loops. | `resolve-issue`, `trajectory-log` |
198
- | **systematic-debugger** | Methodical 4-phase debugging (RCA). | `debug-session`, `analyze-logs` |
199
- | **tech-lead** | Code review, technical decision making, mentoring. | `review-pr`, `enforce-standards` |
200
- | **technical-writer** | Documentation, API refs, user guides. | `generate-docs`, `update-readme` |
201
- | **testing-strategist** | Test planning, pyramid strategy, coverage goals. | `plan-testing`, `define-coverage` |
202
- | **ux-ui-designer** | Design systems, user flow, prototyping. | `analyze-ux`, `generate-palette` |
203
-
204
-
205
- ### 2. 📜 Rules (Context & Guardrails)
206
- *Constraints and guidelines that shape Agent behavior.*
207
- **Location:** `{ide}/rules/` or `~/.agents/rules/`
208
-
209
- | Rule File | Description |
210
- | :--- | :--- |
211
- | **_bootstrap.md** | ⭐ **Entry point**: Startup check, skill activation, critical rules for ALL IDEs. |
212
- | **agents-ia.md** | Core guidelines for building AI Agents (Tool-first, Stateless, Observable). |
213
- | **api-design.md** | REST/GraphQL standards, error handling, versioning best practices. |
214
- | **automations-n8n.md** | Best practices for building robust n8n workflows. |
215
- | **code-style.md** | Linter configuration, naming conventions, project structure. |
216
- | **documentation.md** | Standards for code comments, READMEs, and architectural decision records (ADRs). |
217
- | **security.md** | **Critical**: Input validation, secret management, OWASP Top 10 prevention. |
218
- | **stack.md** | Approved technology stack and library choices for the project. |
219
- | **testing.md** | Mandatory Test-Driven Development (TDD) workflows and coverage requirements. |
220
- | **workflow.md** | General git flow and contribution guidelines. |
221
-
222
-
223
- ### 3. ⚡ Workflows (SOPs)
224
- *Step-by-step guides for complex tasks.*
225
- **Location:** `{ide}/workflows/` or `~/.agents/workflows/`
226
-
227
- | Workflow Name | Purpose |
228
- | :--- | :--- |
229
- | **bugfix-backend.md** | Protocol for diagnosing, fixing, and verifying server-side bugs. |
230
- | **documentation.md** | Guide for updating and maintaining project documentation. |
231
- | **generate-prd.md** | Template and instructions for creating Product Requirement Documents. |
232
- | **ideation.md** | Brainstorming process for new features or products. |
233
- | **new-agent-ia.md** | End-to-end guide for creating a new AI Agent from scratch. |
234
- | **new-automation.md** | Steps to design and deploy a new automation (n8n/script). |
235
- | **new-feature.md** | Standard flow: Ticket -> Design -> Implementation -> Test -> PR. |
236
- | **optimize-performance.md** | Systematic approach to identifying and fixing bottlenecks. |
237
- | **resolve-github-issue.md** | Standard flow for addressing GitHub Issues. |
238
- | **security-review.md** | Checklist for pre-deployment security audits. |
239
- | **spec-driven.md** | Development methodology based on detailed specifications (Spec-First). |
240
- | **testing-strategy.md** | Defining the testing pyramid and strategy for a feature. |
241
- | **third-party-integration.md** | Guide for securely integrating external APIs and SDKs. |
256
+ ## 👨‍💻 Developer Setup
242
257
 
243
- ---
258
+ If you are contributing to the framework:
244
259
 
245
- ## 💎 Features & IDE Support
246
-
247
- ### 🌍 Centralized "Brain" (`~/.agents`)
248
- LMAgent creates a **Single Source of Truth** in your home directory.
249
- * **Update Once, Reflect Everywhere**: Modify a rule in `~/.agents/rules/code-style.md`, and *every project* using Symlinks updates instantly.
250
- * **Zero-Copy Efficiency**: No more valid/duplicate `.md` files cluttering every repo.
251
-
252
- ### 🧩 Multi-IDE Support
253
-
254
-
255
- | IDE | Status | Config Path |
256
- | :--- | :--- | :--- |
257
- | **Cursor** | ✅ Full | `.cursor/` |
258
- | **Windsurf** | ✅ Full | `.windsurf/` |
259
- | **VSCode / Copilot** | ✅ Full | `.github/` |
260
- | **Zed** | ✅ Full | `.rules/` |
261
- | **Antigravity** | ✅ Full | `.agent/` |
262
- | **Claude Code** | ✅ Full | `.claude/` |
263
- | **Cline / Roo Code** | ✅ Full | `.clinerules/` / `.roo/` |
264
- | **Continue** | ✅ Full | `.continue/` |
265
- | **Trae** | ✅ Full | `.trae/` |
266
- | **Qodo** | ✅ Full | `agents/` |
267
- | **Amp / Kimi / Replit** | ✅ Full | `.agents/` |
268
- | **Augment** | ✅ Full | `.augment/` |
269
- | **Codex** | ✅ Full | `.codex/` |
270
- | **Gemini CLI** | ✅ Full | `.gemini/` |
271
- | **OpenCode** | ✅ Full | `.opencode/` |
272
- | **OpenHands** | ✅ Full | `.openhands/` |
273
- | **Goose** | ✅ Full | `.goose/` |
274
- | **Mistral Vibe** | ✅ Full | `.vibe/` |
275
- | **Envoid (OpenClaw)** | ✅ Full | `openclaw.json` |
276
- | **CodeBuddy** | ✅ Full | `.codebuddy/` |
277
- | **Command Code** | ✅ Full | `.commandcode/` |
278
- | **Crush** | ✅ Full | `.crush/` |
279
- | **Droid** | ✅ Full | `.factory/` |
280
- | **Junie** | ✅ Full | `.junie/` |
281
- | **iFlow** | ✅ Full | `.iflow/` |
282
- | **Kilo Code** | ✅ Full | `.kilocode/` |
283
- | **Kiro** | ✅ Full | `.kiro/` |
284
- | **Kode** | ✅ Full | `.kode/` |
285
- | **MCPJam** | ✅ Full | `.mcpjam/` |
286
- | **Mux** | ✅ Full | `.mux/` |
287
- | **Pi** | ✅ Full | `.pi/` |
288
- | **Qoder** | ✅ Full | `.qoder/` |
289
- | **Qwen Code** | ✅ Full | `.qwen/` |
290
- | **Trae CN** | ✅ Full | `.trae-cn/` |
291
- | **Zencoder** | ✅ Full | `.zencoder/` |
292
- | **Neovate** | ✅ Full | `.neovate/` |
293
- | **Pochi** | ✅ Full | `.pochi/` |
294
- | **AdaL** | ✅ Full | `.adal/` |
260
+ ```bash
261
+ git clone https://github.com/QuBiit0/lmagent.git
262
+ cd lmagent
263
+ npm install
264
+ npm link
265
+ lmagent doctor
266
+ ```
295
267
 
296
268
  ---
297
269
 
@@ -300,11 +272,8 @@ LMAgent creates a **Single Source of Truth** in your home directory.
300
272
  We welcome contributions to expand the **Universal Agent Brain**.
301
273
  Check out `CONTRIBUTING.md` to add new Skills, Rules, or IDE support.
302
274
 
303
-
304
-
305
-
306
275
  ---
307
276
 
308
277
  <p align="center">
309
- Built with ❤️ by <b>QuBit</b>
278
+ Built with ❤️ by <b>QuBit</b> · <a href="https://github.com/QuBiit0/lmagent">GitHub</a>
310
279
  </p>