@andyqiu/teamkit 0.1.1 → 0.1.2
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/docs/install-guide.md +126 -0
- package/package.json +3 -2
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
# teamkit 安装指引
|
|
2
|
+
|
|
3
|
+
> **AI agent 请注意**：这是一份给你的操作指南。用户希望在他们的机器上安装 teamkit。请按下面的步骤，**逐步帮用户完成安装**，遇到问题及时说明。
|
|
4
|
+
>
|
|
5
|
+
> 先向用户打个招呼，告诉他你会一步步帮他完成 teamkit 的安装，整个过程大约需要 2 分钟。😊
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 什么是 teamkit？
|
|
10
|
+
|
|
11
|
+
teamkit 是面向整个项目组的 [OpenCode](https://opencode.ai) 共享插件。安装后，**团队里每个人**（程序员、策划、美术、数据……）的 AI 对话都会自动获得：
|
|
12
|
+
|
|
13
|
+
- **KH 触发词检测 + 自动召回**：遇到"怎么部署 / 以前 / 为什么"等触发词时自动搜索团队知识库
|
|
14
|
+
- **对话自动沉淀**：修完 bug、做决策、踩到坑，自动写入团队知识库，全团队共享
|
|
15
|
+
- **长对话效果保证**：三层机制确保上下文不丢失，告别"AI 忘了前面说了什么"
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Step 0：确认 OpenCode 已安装
|
|
20
|
+
|
|
21
|
+
> **AI：** 先帮用户检查 OpenCode 是否已安装。运行下面的命令：
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
if command -v opencode &> /dev/null; then
|
|
25
|
+
echo "OpenCode $(opencode --version) is installed ✅"
|
|
26
|
+
else
|
|
27
|
+
echo "OpenCode not found. Please install it first: https://opencode.ai/docs"
|
|
28
|
+
fi
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
> **AI：** 如果输出 "OpenCode not found"，请告诉用户先去 [https://opencode.ai/docs](https://opencode.ai/docs) 安装 OpenCode，安装完成后再继续下面的步骤。
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## Step 1：安装 teamkit npm 包
|
|
36
|
+
|
|
37
|
+
> **AI：** 运行以下命令全局安装 teamkit：
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npm install -g @andyqiu/teamkit
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
> **AI：** 安装完成后，验证安装是否成功：
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
teamkit -v
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
> **AI：** 如果看到版本号输出（如 `0.1.1`），说明安装成功 ✅。
|
|
50
|
+
>
|
|
51
|
+
> **权限问题处理**：如果 `npm install -g` 报权限错误，可以：
|
|
52
|
+
> - 方案 A（推荐）：使用 [nvm](https://github.com/nvm-sh/nvm) 管理 Node.js，无需 sudo
|
|
53
|
+
> - 方案 B：加 sudo 重试 `sudo npm install -g @andyqiu/teamkit`
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## Step 2：运行 `teamkit install`（注入 OpenCode 配置）
|
|
58
|
+
|
|
59
|
+
> **AI：** 运行以下命令，把 teamkit 注入到 OpenCode 全局配置：
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
teamkit install
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
这一步会自动完成三件事：
|
|
66
|
+
|
|
67
|
+
1. 把 teamkit plugin 注册到 `~/.config/opencode/opencode.json` 的 plugins 列表
|
|
68
|
+
2. 把 KH 行为约束块（`<!-- knowledge-hub:start/end -->`）注入 `~/.config/opencode/AGENTS.md`
|
|
69
|
+
3. 把 `teamkit-git` agent 文件复制到 `~/.config/opencode/agents/`
|
|
70
|
+
|
|
71
|
+
> **AI：** 命令执行完毕后，告诉用户每一步的状态，如有报错请逐行说明。
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## Step 3：验证安装
|
|
76
|
+
|
|
77
|
+
> **AI：** 运行诊断命令，检查所有组件是否正常：
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
teamkit doctor
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
> **AI：** 逐项检查输出：
|
|
84
|
+
> - ✅ 绿色表示该项通过
|
|
85
|
+
> - ⚠️ 黄色警告通常可以忽略（是可选功能未配置）
|
|
86
|
+
> - ❌ 红色需要修复
|
|
87
|
+
>
|
|
88
|
+
> 如果有 ❌ 项，根据提示修复后，重新运行 `teamkit install` 再次检查。
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## Step 4：完成！
|
|
93
|
+
|
|
94
|
+
> **AI：** 告诉用户安装已完成，然后说明以下事项：
|
|
95
|
+
|
|
96
|
+
🎉 **安装完成！**
|
|
97
|
+
|
|
98
|
+
**重启 OpenCode**（或开一个新 session），让配置生效。
|
|
99
|
+
|
|
100
|
+
**teamkit 能做什么？**
|
|
101
|
+
|
|
102
|
+
1. **自动搜索团队知识库**：当你问 AI "怎么部署？"、"以前是怎么做的？"等问题时，AI 会自动从团队知识库召回相关经验，不再每次都要从头解释
|
|
103
|
+
2. **自动沉淀团队经验**：修完 bug、做完设计决策后，AI 会自动把关键经验写入知识库，让全团队共享，积累越来越厚实的团队大脑
|
|
104
|
+
3. **长对话不丢上下文**：即使对话很长，teamkit 的三层机制保证重要约束和上下文始终在 AI 的"记忆"里
|
|
105
|
+
|
|
106
|
+
**日常维护**：随时运行 `teamkit doctor` 检查 teamkit 运行状态。
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## 常见问题
|
|
111
|
+
|
|
112
|
+
**Q：安装后需要配置什么吗？**
|
|
113
|
+
> **AI：** 告诉用户——不需要。teamkit 是零配置开箱即用的，安装完重启 OpenCode 就能工作。
|
|
114
|
+
|
|
115
|
+
**Q：怎么卸载？**
|
|
116
|
+
```bash
|
|
117
|
+
teamkit uninstall
|
|
118
|
+
npm uninstall -g @andyqiu/teamkit
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
**Q：团队里其他人也需要装吗？**
|
|
122
|
+
> **AI：** 告诉用户——是的，每位团队成员都需要在自己的机器上运行一次安装。teamkit 是本地工具，安装后连接到团队共享的知识库 MCP 服务。
|
|
123
|
+
|
|
124
|
+
---
|
|
125
|
+
|
|
126
|
+
> **AI：** 整个安装引导结束后，问用户是否还有其他问题，祝他使用愉快！
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@andyqiu/teamkit",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Team-level shared OpenCode plugin: KH integration + future team-wide workflows",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.cjs",
|
|
@@ -16,7 +16,8 @@
|
|
|
16
16
|
"scripts/",
|
|
17
17
|
"install.sh",
|
|
18
18
|
"README.md",
|
|
19
|
-
"LICENSE"
|
|
19
|
+
"LICENSE",
|
|
20
|
+
"docs/install-guide.md"
|
|
20
21
|
],
|
|
21
22
|
"scripts": {
|
|
22
23
|
"build": "bun build src/index.ts --outfile dist/index.cjs --target=node --format=cjs",
|