@zeyue0329/xiaoma-cli 1.0.0
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/.releaserc.json +18 -0
- package/.vscode/settings.json +44 -0
- package/CONTRIBUTING.md +209 -0
- package/LICENSE +21 -0
- package/QUICK-START.md +173 -0
- package/README.md +532 -0
- package/common/tasks/create-doc.md +101 -0
- package/common/tasks/execute-checklist.md +93 -0
- package/common/utils/bmad-doc-template.md +325 -0
- package/common/utils/workflow-management.md +69 -0
- package/dist/agents/analyst.txt +2882 -0
- package/dist/agents/architect.txt +3543 -0
- package/dist/agents/dev.txt +428 -0
- package/dist/agents/pm.txt +2229 -0
- package/dist/agents/po.txt +1364 -0
- package/dist/agents/qa.txt +386 -0
- package/dist/agents/sm.txt +668 -0
- package/dist/agents/ux-expert.txt +701 -0
- package/dist/agents/xiaoma-master.txt +8756 -0
- package/dist/agents/xiaoma-orchestrator.txt +1490 -0
- package/dist/teams/team-all.txt +11062 -0
- package/dist/teams/team-fullstack.txt +10392 -0
- package/dist/teams/team-ide-minimal.txt +3507 -0
- package/dist/teams/team-no-ui.txt +8951 -0
- package/docs/GUIDING-PRINCIPLES.md +91 -0
- package/docs/core-architecture.md +219 -0
- package/docs/expansion-packs.md +280 -0
- package/docs/versioning-and-releases.md +77 -0
- package/docs/versions.md +48 -0
- package/expansion-packs/README.md +3 -0
- package/package.json +80 -0
- package/tools/bmad-npx-wrapper.js +39 -0
- package/tools/builders/web-builder.js +681 -0
- package/tools/bump-all-versions.js +106 -0
- package/tools/bump-expansion-version.js +83 -0
- package/tools/cli.js +152 -0
- package/tools/flattener/main.js +570 -0
- package/tools/installer/README.md +8 -0
- package/tools/installer/bin/xiaoma.js +326 -0
- package/tools/installer/config/ide-agent-config.yaml +58 -0
- package/tools/installer/config/install.config.yaml +113 -0
- package/tools/installer/lib/config-loader.js +253 -0
- package/tools/installer/lib/file-manager.js +411 -0
- package/tools/installer/lib/ide-base-setup.js +227 -0
- package/tools/installer/lib/ide-setup.js +1302 -0
- package/tools/installer/lib/installer.js +1772 -0
- package/tools/installer/lib/memory-profiler.js +224 -0
- package/tools/installer/lib/module-manager.js +110 -0
- package/tools/installer/lib/resource-locator.js +310 -0
- package/tools/installer/package-lock.json +906 -0
- package/tools/installer/package.json +43 -0
- package/tools/lib/dependency-resolver.js +179 -0
- package/tools/lib/yaml-utils.js +29 -0
- package/tools/md-assets/web-agent-startup-instructions.md +39 -0
- package/tools/semantic-release-sync-installer.js +30 -0
- package/tools/sync-installer-version.js +34 -0
- package/tools/update-expansion-version.js +54 -0
- package/tools/upgraders/v3-to-v4-upgrader.js +763 -0
- package/tools/version-bump.js +79 -0
- package/tools/xiaoma-npx-wrapper.js +39 -0
- package/tools/yaml-format.js +240 -0
- package/xiaoma-core/agent-teams/team-all.yaml +14 -0
- package/xiaoma-core/agent-teams/team-fullstack.yaml +18 -0
- package/xiaoma-core/agent-teams/team-ide-minimal.yaml +10 -0
- package/xiaoma-core/agent-teams/team-no-ui.yaml +13 -0
- package/xiaoma-core/agents/analyst.md +81 -0
- package/xiaoma-core/agents/architect.md +84 -0
- package/xiaoma-core/agents/dev.md +76 -0
- package/xiaoma-core/agents/pm.md +81 -0
- package/xiaoma-core/agents/po.md +76 -0
- package/xiaoma-core/agents/qa.md +69 -0
- package/xiaoma-core/agents/sm.md +62 -0
- package/xiaoma-core/agents/ux-expert.md +66 -0
- package/xiaoma-core/agents/xiaoma-master.md +108 -0
- package/xiaoma-core/agents/xiaoma-orchestrator.md +150 -0
- package/xiaoma-core/bmad-core/user-guide.md +0 -0
- package/xiaoma-core/checklists/architect-checklist.md +443 -0
- package/xiaoma-core/checklists/change-checklist.md +182 -0
- package/xiaoma-core/checklists/pm-checklist.md +375 -0
- package/xiaoma-core/checklists/po-master-checklist.md +441 -0
- package/xiaoma-core/checklists/story-dod-checklist.md +101 -0
- package/xiaoma-core/checklists/story-draft-checklist.md +156 -0
- package/xiaoma-core/core-config.yaml +20 -0
- package/xiaoma-core/data/brainstorming-techniques.md +36 -0
- package/xiaoma-core/data/elicitation-methods.md +134 -0
- package/xiaoma-core/data/technical-preferences.md +3 -0
- package/xiaoma-core/data/xiaoma-kb.md +803 -0
- package/xiaoma-core/enhanced-ide-development-workflow.md +43 -0
- package/xiaoma-core/tasks/advanced-elicitation.md +117 -0
- package/xiaoma-core/tasks/brownfield-create-epic.md +160 -0
- package/xiaoma-core/tasks/brownfield-create-story.md +147 -0
- package/xiaoma-core/tasks/correct-course.md +70 -0
- package/xiaoma-core/tasks/create-brownfield-story.md +304 -0
- package/xiaoma-core/tasks/create-deep-research-prompt.md +289 -0
- package/xiaoma-core/tasks/create-next-story.md +112 -0
- package/xiaoma-core/tasks/document-project.md +341 -0
- package/xiaoma-core/tasks/facilitate-brainstorming-session.md +136 -0
- package/xiaoma-core/tasks/generate-ai-frontend-prompt.md +51 -0
- package/xiaoma-core/tasks/index-docs.md +179 -0
- package/xiaoma-core/tasks/kb-mode-interaction.md +75 -0
- package/xiaoma-core/tasks/review-story.md +145 -0
- package/xiaoma-core/tasks/shard-doc.md +187 -0
- package/xiaoma-core/tasks/validate-next-story.md +134 -0
- package/xiaoma-core/templates/architecture-tmpl.yaml +650 -0
- package/xiaoma-core/templates/brainstorming-output-tmpl.yaml +156 -0
- package/xiaoma-core/templates/brownfield-architecture-tmpl.yaml +476 -0
- package/xiaoma-core/templates/brownfield-prd-tmpl.yaml +280 -0
- package/xiaoma-core/templates/competitor-analysis-tmpl.yaml +293 -0
- package/xiaoma-core/templates/front-end-architecture-tmpl.yaml +206 -0
- package/xiaoma-core/templates/front-end-spec-tmpl.yaml +349 -0
- package/xiaoma-core/templates/fullstack-architecture-tmpl.yaml +805 -0
- package/xiaoma-core/templates/market-research-tmpl.yaml +252 -0
- package/xiaoma-core/templates/prd-tmpl.yaml +202 -0
- package/xiaoma-core/templates/project-brief-tmpl.yaml +221 -0
- package/xiaoma-core/templates/story-tmpl.yaml +137 -0
- package/xiaoma-core/user-guide.md +251 -0
- package/xiaoma-core/workflows/brownfield-fullstack.yaml +297 -0
- package/xiaoma-core/workflows/brownfield-service.yaml +187 -0
- package/xiaoma-core/workflows/brownfield-ui.yaml +197 -0
- package/xiaoma-core/workflows/greenfield-fullstack.yaml +240 -0
- package/xiaoma-core/workflows/greenfield-service.yaml +206 -0
- package/xiaoma-core/workflows/greenfield-ui.yaml +235 -0
- package/xiaoma-core/working-in-the-brownfield.md +364 -0
package/.releaserc.json
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
{
|
|
2
|
+
"branches": ["main"],
|
|
3
|
+
"plugins": [
|
|
4
|
+
"@semantic-release/commit-analyzer",
|
|
5
|
+
"@semantic-release/release-notes-generator",
|
|
6
|
+
"@semantic-release/changelog",
|
|
7
|
+
"@semantic-release/npm",
|
|
8
|
+
"./tools/semantic-release-sync-installer.js",
|
|
9
|
+
[
|
|
10
|
+
"@semantic-release/git",
|
|
11
|
+
{
|
|
12
|
+
"assets": ["package.json", "package-lock.json", "tools/installer/package.json", "CHANGELOG.md"],
|
|
13
|
+
"message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
|
|
14
|
+
}
|
|
15
|
+
],
|
|
16
|
+
"@semantic-release/github"
|
|
17
|
+
]
|
|
18
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
{
|
|
2
|
+
"cSpell.words": [
|
|
3
|
+
"Agentic",
|
|
4
|
+
"atlasing",
|
|
5
|
+
"Biostatistician",
|
|
6
|
+
"Cordova",
|
|
7
|
+
"customresourcedefinitions",
|
|
8
|
+
"dashboarded",
|
|
9
|
+
"Decisioning",
|
|
10
|
+
"eksctl",
|
|
11
|
+
"elicitations",
|
|
12
|
+
"filecomplete",
|
|
13
|
+
"fintech",
|
|
14
|
+
"fluxcd",
|
|
15
|
+
"gamedev",
|
|
16
|
+
"gitops",
|
|
17
|
+
"implementability",
|
|
18
|
+
"inclusivity",
|
|
19
|
+
"ingressgateway",
|
|
20
|
+
"istioctl",
|
|
21
|
+
"metroidvania",
|
|
22
|
+
"NACLs",
|
|
23
|
+
"nodegroup",
|
|
24
|
+
"platformconfigs",
|
|
25
|
+
"Playfocus",
|
|
26
|
+
"playtesting",
|
|
27
|
+
"pointerdown",
|
|
28
|
+
"pointerup",
|
|
29
|
+
"Polyrepo",
|
|
30
|
+
"replayability",
|
|
31
|
+
"roguelike",
|
|
32
|
+
"roomodes",
|
|
33
|
+
"Runbook",
|
|
34
|
+
"runbooks",
|
|
35
|
+
"Shardable",
|
|
36
|
+
"Softlock",
|
|
37
|
+
"speedrunner",
|
|
38
|
+
"tekton",
|
|
39
|
+
"tilemap",
|
|
40
|
+
"tileset",
|
|
41
|
+
"Trae",
|
|
42
|
+
"VNET"
|
|
43
|
+
]
|
|
44
|
+
}
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
# Contributing to this project
|
|
2
|
+
|
|
3
|
+
Thank you for considering contributing to this project! This document outlines the process for contributing and some guidelines to follow.
|
|
4
|
+
|
|
5
|
+
🆕 **New to GitHub or pull requests?** Check out our [beginner-friendly Pull Request Guide](docs/how-to-contribute-with-pull-requests.md) first!
|
|
6
|
+
|
|
7
|
+
📋 **Before contributing**, please read our [Guiding Principles](docs/GUIDING-PRINCIPLES.md) to understand the XiaoMa Method's core philosophy and architectural decisions.
|
|
8
|
+
|
|
9
|
+
Also note, we use the discussions feature in GitHub to have a community to discuss potential ideas, uses, additions and enhancements.
|
|
10
|
+
|
|
11
|
+
💬 **Discord Community**: Join our [Discord server](https://discord.gg/gk8jAdXWmj) for real-time discussions:
|
|
12
|
+
|
|
13
|
+
- **#general-dev** - Technical discussions, feature ideas, and development questions
|
|
14
|
+
- **#bugs-issues** - Bug reports and issue discussions
|
|
15
|
+
|
|
16
|
+
## Code of Conduct
|
|
17
|
+
|
|
18
|
+
By participating in this project, you agree to abide by our Code of Conduct. Please read it before participating.
|
|
19
|
+
|
|
20
|
+
## How to Contribute
|
|
21
|
+
|
|
22
|
+
### Reporting Bugs
|
|
23
|
+
|
|
24
|
+
1. **Check existing issues** first to avoid duplicates
|
|
25
|
+
2. **Use the bug report template** when creating a new issue - it will guide you through providing:
|
|
26
|
+
- Clear bug description
|
|
27
|
+
- Steps to reproduce
|
|
28
|
+
- Expected vs actual behavior
|
|
29
|
+
- Model/IDE/XiaoMa version details
|
|
30
|
+
- Screenshots or links if applicable
|
|
31
|
+
3. **Consider discussing in Discord** (#bugs-issues channel) for quick help
|
|
32
|
+
4. **Indicate if you're working on a fix** to avoid duplicate efforts
|
|
33
|
+
|
|
34
|
+
### Suggesting Features
|
|
35
|
+
|
|
36
|
+
1. **Discuss first in Discord** (#general-dev channel) - the feature request template asks if you've done this
|
|
37
|
+
2. **Check existing issues and discussions** to avoid duplicates
|
|
38
|
+
3. **Use the feature request template** when creating an issue - it will guide you through:
|
|
39
|
+
- Confirming Discord discussion
|
|
40
|
+
- Describing the problem it solves
|
|
41
|
+
- Explaining your solution
|
|
42
|
+
- Listing alternatives considered
|
|
43
|
+
4. **Be specific** about why this feature would benefit the XiaoMa community
|
|
44
|
+
|
|
45
|
+
### Pull Request Process
|
|
46
|
+
|
|
47
|
+
⚠️ **Before starting work:**
|
|
48
|
+
|
|
49
|
+
1. **For bugs**: Check if an issue exists (create one using the bug template if not)
|
|
50
|
+
2. **For features**: Ensure you've discussed in Discord (#general-dev) AND created a feature request issue
|
|
51
|
+
3. **For large changes**: Always open an issue first to discuss alignment
|
|
52
|
+
|
|
53
|
+
Please only propose small granular commits! If its large or significant, please discuss in the discussions tab and open up an issue first. I do not want you to waste your time on a potentially very large PR to have it rejected because it is not aligned or deviates from other planned changes. Communicate and lets work together to build and improve this great community project!
|
|
54
|
+
|
|
55
|
+
**Important**: All contributions must align with our [Guiding Principles](docs/GUIDING-PRINCIPLES.md). Key points:
|
|
56
|
+
|
|
57
|
+
- Keep dev agents lean - they need context for coding, not documentation
|
|
58
|
+
- Web/planning agents can be larger with more complex tasks
|
|
59
|
+
- Everything is natural language (markdown) - no code in core framework
|
|
60
|
+
- Use expansion packs for domain-specific features
|
|
61
|
+
|
|
62
|
+
#### Which Branch for Your PR?
|
|
63
|
+
|
|
64
|
+
**Submit to `next` branch** (most contributions):
|
|
65
|
+
|
|
66
|
+
- ✨ New features or agents
|
|
67
|
+
- 🎨 Enhancements to existing features
|
|
68
|
+
- 📚 Documentation updates
|
|
69
|
+
- ♻️ Code refactoring
|
|
70
|
+
- ⚡ Performance improvements
|
|
71
|
+
- 🧪 New tests
|
|
72
|
+
- 🎁 New expansion packs
|
|
73
|
+
|
|
74
|
+
**Submit to `main` branch** (critical only):
|
|
75
|
+
|
|
76
|
+
- 🚨 Critical bug fixes that break basic functionality
|
|
77
|
+
- 🔒 Security patches
|
|
78
|
+
- 📚 Fixing dangerously incorrect documentation
|
|
79
|
+
- 🐛 Bugs preventing installation or basic usage
|
|
80
|
+
|
|
81
|
+
**When in doubt, submit to `next`**. We'd rather test changes thoroughly before they hit stable.
|
|
82
|
+
|
|
83
|
+
#### PR Size Guidelines
|
|
84
|
+
|
|
85
|
+
- **Ideal PR size**: 200-400 lines of code changes
|
|
86
|
+
- **Maximum PR size**: 800 lines (excluding generated files)
|
|
87
|
+
- **One feature/fix per PR**: Each PR should address a single issue or add one feature
|
|
88
|
+
- **If your change is larger**: Break it into multiple smaller PRs that can be reviewed independently
|
|
89
|
+
- **Related changes**: Even related changes should be separate PRs if they deliver independent value
|
|
90
|
+
|
|
91
|
+
#### Breaking Down Large PRs
|
|
92
|
+
|
|
93
|
+
If your change exceeds 800 lines, use this checklist to split it:
|
|
94
|
+
|
|
95
|
+
- [ ] Can I separate the refactoring from the feature implementation?
|
|
96
|
+
- [ ] Can I introduce the new API/interface in one PR and implementation in another?
|
|
97
|
+
- [ ] Can I split by file or module?
|
|
98
|
+
- [ ] Can I create a base PR with shared utilities first?
|
|
99
|
+
- [ ] Can I separate test additions from implementation?
|
|
100
|
+
- [ ] Even if changes are related, can they deliver value independently?
|
|
101
|
+
- [ ] Can these changes be merged in any order without breaking things?
|
|
102
|
+
|
|
103
|
+
Example breakdown:
|
|
104
|
+
|
|
105
|
+
1. PR #1: Add utility functions and types (100 lines)
|
|
106
|
+
2. PR #2: Refactor existing code to use utilities (200 lines)
|
|
107
|
+
3. PR #3: Implement new feature using refactored code (300 lines)
|
|
108
|
+
4. PR #4: Add comprehensive tests (200 lines)
|
|
109
|
+
|
|
110
|
+
**Note**: PRs #1 and #4 could be submitted simultaneously since they deliver independent value and don't depend on each other's merge order.
|
|
111
|
+
|
|
112
|
+
#### Pull Request Steps
|
|
113
|
+
|
|
114
|
+
1. Fork the repository
|
|
115
|
+
2. Create a new branch (`git checkout -b feature/your-feature-name`)
|
|
116
|
+
3. Make your changes
|
|
117
|
+
4. Run any tests or linting to ensure quality
|
|
118
|
+
5. Commit your changes with clear, descriptive messages following our commit message convention
|
|
119
|
+
6. Push to your branch (`git push origin feature/your-feature-name`)
|
|
120
|
+
7. Open a Pull Request against the main branch
|
|
121
|
+
|
|
122
|
+
## Issue Templates
|
|
123
|
+
|
|
124
|
+
We use GitHub issue templates to ensure all necessary information is provided:
|
|
125
|
+
|
|
126
|
+
- **Bug Reports**: Automatically guides you through providing reproduction steps, environment details, and expected behavior
|
|
127
|
+
- **Feature Requests**: Requires Discord discussion confirmation and asks for problem/solution descriptions
|
|
128
|
+
|
|
129
|
+
Using these templates helps maintainers understand and address your contribution faster.
|
|
130
|
+
|
|
131
|
+
## Pull Request Description Guidelines
|
|
132
|
+
|
|
133
|
+
Keep PR descriptions short and to the point following this template:
|
|
134
|
+
|
|
135
|
+
### PR Description Template
|
|
136
|
+
|
|
137
|
+
Keep your PR description concise and focused. Use this template:
|
|
138
|
+
|
|
139
|
+
```markdown
|
|
140
|
+
## What
|
|
141
|
+
|
|
142
|
+
[1-2 sentences describing WHAT changed]
|
|
143
|
+
|
|
144
|
+
## Why
|
|
145
|
+
|
|
146
|
+
[1-2 sentences explaining WHY this change is needed]
|
|
147
|
+
Fixes #[issue number] (if applicable)
|
|
148
|
+
|
|
149
|
+
## How
|
|
150
|
+
|
|
151
|
+
[2-3 bullets listing HOW you implemented it]
|
|
152
|
+
|
|
153
|
+
-
|
|
154
|
+
-
|
|
155
|
+
-
|
|
156
|
+
|
|
157
|
+
## Testing
|
|
158
|
+
|
|
159
|
+
[1-2 sentences on how you tested this]
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
**Maximum PR description length: 200 words** (excluding code examples if needed)
|
|
163
|
+
|
|
164
|
+
### Good vs Bad PR Descriptions
|
|
165
|
+
|
|
166
|
+
❌ **Bad Example:**
|
|
167
|
+
|
|
168
|
+
> This revolutionary PR introduces a paradigm-shifting enhancement to the system's architecture by implementing a state-of-the-art solution that leverages cutting-edge methodologies to optimize performance metrics and deliver unprecedented value to stakeholders through innovative approaches...
|
|
169
|
+
|
|
170
|
+
✅ **Good Example:**
|
|
171
|
+
|
|
172
|
+
> **What:** Added validation for agent dependency resolution
|
|
173
|
+
> **Why:** Build was failing silently when agents had circular dependencies
|
|
174
|
+
> **How:**
|
|
175
|
+
>
|
|
176
|
+
> - Added cycle detection in dependency-resolver.js
|
|
177
|
+
> - Throws clear error with dependency chain
|
|
178
|
+
> **Testing:** Tested with circular deps between 3 agents
|
|
179
|
+
|
|
180
|
+
## Commit Message Convention
|
|
181
|
+
|
|
182
|
+
Use conventional commits format:
|
|
183
|
+
|
|
184
|
+
- `feat:` New feature
|
|
185
|
+
- `fix:` Bug fix
|
|
186
|
+
- `docs:` Documentation only
|
|
187
|
+
- `refactor:` Code change that neither fixes a bug nor adds a feature
|
|
188
|
+
- `test:` Adding missing tests
|
|
189
|
+
- `chore:` Changes to build process or auxiliary tools
|
|
190
|
+
|
|
191
|
+
Keep commit messages under 72 characters.
|
|
192
|
+
|
|
193
|
+
### Atomic Commits
|
|
194
|
+
|
|
195
|
+
Each commit should represent one logical change:
|
|
196
|
+
|
|
197
|
+
- **Do:** One bug fix per commit
|
|
198
|
+
- **Do:** One feature addition per commit
|
|
199
|
+
- **Don't:** Mix refactoring with bug fixes
|
|
200
|
+
- **Don't:** Combine unrelated changes
|
|
201
|
+
|
|
202
|
+
## Code Style
|
|
203
|
+
|
|
204
|
+
- Follow the existing code style and conventions
|
|
205
|
+
- Write clear comments for complex logic
|
|
206
|
+
|
|
207
|
+
## License
|
|
208
|
+
|
|
209
|
+
By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Brian AKA BMad AKA BMad Code
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/QUICK-START.md
ADDED
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
# 🚀 XIAOMA-WEB 快速启动指南
|
|
2
|
+
|
|
3
|
+
## 项目已成功启动!✅
|
|
4
|
+
|
|
5
|
+
### 📦 当前状态
|
|
6
|
+
- ✅ 项目依赖已安装
|
|
7
|
+
- ✅ 构建系统正常运行
|
|
8
|
+
- ✅ 所有配置文件验证通过
|
|
9
|
+
- ✅ CLI工具正常工作
|
|
10
|
+
- ✅ dist文件已生成
|
|
11
|
+
|
|
12
|
+
### 🎯 项目概述
|
|
13
|
+
XIAOMA-WEB是一个通用AI代理框架,支持敏捷AI驱动开发。提供专业的AI代理团队来处理项目的各个环节。
|
|
14
|
+
|
|
15
|
+
## 🔧 可用命令
|
|
16
|
+
|
|
17
|
+
### 🚨 重要说明
|
|
18
|
+
目前XIAOMA-WEB还没有发布到npm仓库,所以需要使用本地安装方式。
|
|
19
|
+
|
|
20
|
+
### 方法1: 使用本地路径(推荐)
|
|
21
|
+
```bash
|
|
22
|
+
# 在任何目录中直接使用完整路径
|
|
23
|
+
npx /Users/liueryang/Documents/gitlab/xiaoma-web install
|
|
24
|
+
|
|
25
|
+
# 查看帮助
|
|
26
|
+
npx /Users/liueryang/Documents/gitlab/xiaoma-web install --help
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### 方法2: 全局链接方式
|
|
30
|
+
```bash
|
|
31
|
+
# 1. 首先在xiaoma-web项目目录中创建全局链接(仅需一次)
|
|
32
|
+
cd /Users/liueryang/Documents/gitlab/xiaoma-web
|
|
33
|
+
npm link
|
|
34
|
+
|
|
35
|
+
# 2. 然后在任何目录中使用
|
|
36
|
+
xiaoma-web --version
|
|
37
|
+
xiaoma-web --help
|
|
38
|
+
xiaoma-web install
|
|
39
|
+
|
|
40
|
+
# 构建所有bundles
|
|
41
|
+
npm run build
|
|
42
|
+
|
|
43
|
+
# 验证配置
|
|
44
|
+
npm run validate
|
|
45
|
+
|
|
46
|
+
# 列出可用代理
|
|
47
|
+
npm run list:agents
|
|
48
|
+
|
|
49
|
+
# 代码扁平化
|
|
50
|
+
npm run flatten
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### 开发命令
|
|
54
|
+
```bash
|
|
55
|
+
# 只构建代理bundles
|
|
56
|
+
npm run build:agents
|
|
57
|
+
|
|
58
|
+
# 只构建团队bundles
|
|
59
|
+
npm run build:teams
|
|
60
|
+
|
|
61
|
+
# 安装到项目(使用本地版本)
|
|
62
|
+
npm run install:xiaoma
|
|
63
|
+
|
|
64
|
+
# 格式化markdown
|
|
65
|
+
npm run format
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## 📁 项目结构
|
|
69
|
+
|
|
70
|
+
```
|
|
71
|
+
XIAOMA-WEB/
|
|
72
|
+
├── xiaoma-core/ # 核心框架
|
|
73
|
+
│ ├── agents/ # AI代理定义
|
|
74
|
+
│ ├── agent-teams/ # 代理团队配置
|
|
75
|
+
│ ├── templates/ # 文档模板
|
|
76
|
+
│ ├── tasks/ # 任务定义
|
|
77
|
+
│ ├── workflows/ # 工作流程
|
|
78
|
+
│ └── data/ # 知识库
|
|
79
|
+
├── dist/ # 构建输出
|
|
80
|
+
│ ├── agents/ # 单个代理bundles
|
|
81
|
+
│ ├── teams/ # 团队bundles
|
|
82
|
+
│ └── expansion-packs/ # 扩展包bundles
|
|
83
|
+
├── expansion-packs/ # 扩展包源码
|
|
84
|
+
├── tools/ # 构建和工具脚本
|
|
85
|
+
└── docs/ # 项目文档
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## 🎪 使用方式
|
|
89
|
+
|
|
90
|
+
### 方式1: 在新项目中安装使用
|
|
91
|
+
```bash
|
|
92
|
+
# 在你的项目目录中
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
# 选择安装选项:
|
|
96
|
+
# - Complete XiaoMa Core (完整安装)
|
|
97
|
+
# - Single Agent (单个代理)
|
|
98
|
+
|
|
99
|
+
# 选择IDE集成:
|
|
100
|
+
# - Cursor, Claude Code, Windsurf, VS Code等
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### 方式2: 使用Web UI Bundles
|
|
104
|
+
```bash
|
|
105
|
+
# 获取团队bundle文件
|
|
106
|
+
cp dist/teams/team-fullstack.txt /path/to/upload/
|
|
107
|
+
|
|
108
|
+
# 上传到以下平台之一:
|
|
109
|
+
# - Gemini (推荐用于规划阶段)
|
|
110
|
+
# - ChatGPT
|
|
111
|
+
# - Claude Web UI
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## 🤖 可用代理
|
|
115
|
+
|
|
116
|
+
### 核心代理
|
|
117
|
+
- **analyst** - 业务分析师,市场研究和需求分析
|
|
118
|
+
- **pm** - 产品经理,PRD创建和产品规划
|
|
119
|
+
- **architect** - 系统架构师,技术架构设计
|
|
120
|
+
- **dev** - 开发工程师,代码实现
|
|
121
|
+
- **qa** - 质量保证,代码审查和测试
|
|
122
|
+
- **sm** - Scrum Master,故事管理和流程协调
|
|
123
|
+
- **po** - Product Owner,需求验证和文档分解
|
|
124
|
+
- **ux-expert** - UX专家,用户体验设计
|
|
125
|
+
- **xiaoma-master** - 万能代理,可执行任何任务
|
|
126
|
+
- **xiaoma-orchestrator** - 编排代理,多代理协调
|
|
127
|
+
|
|
128
|
+
### 团队配置
|
|
129
|
+
- **team-fullstack** - 全栈开发团队
|
|
130
|
+
- **team-all** - 包含所有代理
|
|
131
|
+
- **team-ide-minimal** - IDE最小化配置
|
|
132
|
+
- **team-no-ui** - 无UI后端团队
|
|
133
|
+
|
|
134
|
+
## ⚡ 快速开始
|
|
135
|
+
|
|
136
|
+
### IDE开发流程
|
|
137
|
+
1. 在项目中安装:`npx xiaoma-web install`
|
|
138
|
+
2. 选择IDE集成
|
|
139
|
+
3. 使用 `@代理名` 或 `/代理名` 调用代理
|
|
140
|
+
4. 按照SM → Dev循环进行开发
|
|
141
|
+
|
|
142
|
+
### Web UI规划流程
|
|
143
|
+
1. 使用 `dist/teams/team-fullstack.txt`
|
|
144
|
+
2. 上传到Gemini/ChatGPT
|
|
145
|
+
3. 创建PRD和架构文档
|
|
146
|
+
4. 切换到IDE进行开发
|
|
147
|
+
|
|
148
|
+
## 📚 文档资源
|
|
149
|
+
|
|
150
|
+
- **[用户指南](xiaoma-core/user-guide.md)** - 完整使用教程
|
|
151
|
+
- **[架构文档](docs/core-architecture.md)** - 技术架构说明
|
|
152
|
+
- **[贡献指南](CONTRIBUTING.md)** - 如何参与贡献
|
|
153
|
+
- **[CLAUDE.md](CLAUDE.md)** - Claude Code使用指南
|
|
154
|
+
|
|
155
|
+
## 🔗 相关链接
|
|
156
|
+
|
|
157
|
+
- **GitHub**: https://github.com/zqyl-xiaoma/xiaoma-cli
|
|
158
|
+
- **Issues**: https://github.com/zqyl-xiaoma/xiaoma-cli/issues
|
|
159
|
+
- **Discord**: https://discord.gg/gk8jAdXWmj
|
|
160
|
+
|
|
161
|
+
## 🎉 开始使用
|
|
162
|
+
|
|
163
|
+
项目已完全准备就绪!选择您喜欢的方式开始使用XIAOMA-WEB框架。
|
|
164
|
+
|
|
165
|
+
**建议第一次使用:**
|
|
166
|
+
1. 阅读[用户指南](xiaoma-core/user-guide.md)了解工作流程
|
|
167
|
+
2. 在测试项目中运行 `npx xiaoma-web install`
|
|
168
|
+
3. 选择您的IDE进行集成
|
|
169
|
+
4. 开始您的第一个AI辅助开发项目!
|
|
170
|
+
|
|
171
|
+
---
|
|
172
|
+
|
|
173
|
+
**🎊 祝您使用愉快!XIAOMA-WEB团队为您的开发之旅保驾护航!**npx xiaoma-web install
|