bcoder 0.0.2 → 0.0.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.
- package/README.md +121 -24
- package/assets/bg.png +0 -0
- package/package.json +2 -2
- package/README.en.md +0 -36
package/README.md
CHANGED
|
@@ -1,37 +1,134 @@
|
|
|
1
1
|
# bcoder
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
## 介绍
|
|
4
|
+
**bcoder** 是一个极轻量级的企业 AI Coding 助手，专为简化 AI 编程工具的项目初始化和模板管理而设计。
|
|
5
5
|
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
- 快速初始化项目并配置 AI 编程工具目录结构
|
|
7
|
+
- 支持多种 AI 编程工具：Cursor、Claude Code、Trae
|
|
8
|
+
- 轻量级设计，无复杂依赖
|
|
9
|
+
- 不依赖于AI 编程工具，也不依赖于模型
|
|
8
10
|
|
|
11
|
+
<img src="assets/bg.png" alt="bcoder 初始化项目图">
|
|
9
12
|
|
|
10
|
-
|
|
13
|
+
## 软件架构
|
|
11
14
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
+
### 核心功能
|
|
16
|
+
- **初始化功能**：创建项目结构并配置 AI 工具目录
|
|
17
|
+
- **更新功能**：同步 bcoder 模板到已有的 AI 工具目录
|
|
18
|
+
- **工具管理**：支持多种 AI 编程工具的配置
|
|
15
19
|
|
|
16
|
-
|
|
20
|
+
### 项目结构
|
|
21
|
+
```
|
|
22
|
+
bcoder/
|
|
23
|
+
├── bcoder/ # 模板目录
|
|
24
|
+
├── bin/ # 可执行文件
|
|
25
|
+
├── src/ # 源代码
|
|
26
|
+
│ ├── cli/ # CLI 相关代码
|
|
27
|
+
│ └── index.ts # 入口文件
|
|
28
|
+
├── package.json # 项目配置
|
|
29
|
+
└── README.md # 项目文档
|
|
30
|
+
```
|
|
17
31
|
|
|
18
|
-
|
|
19
|
-
2. xxxx
|
|
20
|
-
3. xxxx
|
|
32
|
+
## 安装教程
|
|
21
33
|
|
|
22
|
-
|
|
34
|
+
### 前置条件
|
|
35
|
+
- Node.js >= 18
|
|
36
|
+
- npm 或 yarn 包管理器
|
|
23
37
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
38
|
+
### 全局安装
|
|
39
|
+
```bash
|
|
40
|
+
# 推荐 使用 npm
|
|
41
|
+
npm install -g bcoder
|
|
28
42
|
|
|
43
|
+
# 或使用 yarn
|
|
44
|
+
yarn global add bcoder
|
|
45
|
+
```
|
|
29
46
|
|
|
30
|
-
|
|
47
|
+
## 使用说明
|
|
31
48
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
49
|
+
### 初始化项目
|
|
50
|
+
|
|
51
|
+
#### 基本用法
|
|
52
|
+
```bash
|
|
53
|
+
# 在当前目录初始化
|
|
54
|
+
bcoder init
|
|
55
|
+
|
|
56
|
+
# 在指定目录初始化
|
|
57
|
+
bcoder init <path>
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
#### 选项（可选，不填进入交互界面进行操作）
|
|
61
|
+
- `--tools <tools>`: 选择工具，多个工具用逗号分隔（可选值：cursor, claude, trae）
|
|
62
|
+
- `--force`: 自动清理遗留文件，不提示
|
|
63
|
+
|
|
64
|
+
#### 示例
|
|
65
|
+
```bash
|
|
66
|
+
# 初始化 - 进入交互界面进行操作
|
|
67
|
+
bcoder init
|
|
68
|
+
|
|
69
|
+
# 初始化并指定工具
|
|
70
|
+
bcoder init --tools cursor,claude
|
|
71
|
+
|
|
72
|
+
# 在指定目录初始化
|
|
73
|
+
bcoder init ./my-project
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### 更新模板
|
|
77
|
+
|
|
78
|
+
#### 基本用法
|
|
79
|
+
```bash
|
|
80
|
+
# 更新当前目录的模板
|
|
81
|
+
bcoder update
|
|
82
|
+
|
|
83
|
+
# 更新指定目录的模板
|
|
84
|
+
bcoder update <path>
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
#### 示例
|
|
88
|
+
```bash
|
|
89
|
+
# 更新模板
|
|
90
|
+
bcoder update
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### 支持的工具
|
|
94
|
+
- **Cursor**: 智能代码编辑器
|
|
95
|
+
- **Claude Code**: Anthropic 的代码助手
|
|
96
|
+
- **Trae**: 企业级 AI 开发环境
|
|
97
|
+
|
|
98
|
+
## 命令详解
|
|
99
|
+
|
|
100
|
+
### `bcoder init [path]`
|
|
101
|
+
- **功能**：初始化项目，创建 AI 工具目录结构
|
|
102
|
+
- **参数**：
|
|
103
|
+
- `[path]`: 目标路径，默认为当前目录
|
|
104
|
+
- **选项**：
|
|
105
|
+
- `--tools <tools>`: 选择要配置的 AI 工具
|
|
106
|
+
- `--force`: 自动清理遗留文件
|
|
107
|
+
|
|
108
|
+
### `bcoder update [path]`
|
|
109
|
+
- **功能**：将 bcoder 模板更新到已有的 AI 工具目录
|
|
110
|
+
- **参数**：
|
|
111
|
+
- `[path]`: 目标路径，默认为当前目录
|
|
112
|
+
- **选项**：
|
|
113
|
+
- `--force`: 强制更新模板
|
|
114
|
+
|
|
115
|
+
## 技术栈
|
|
116
|
+
- Node.js >= 18
|
|
117
|
+
- TypeScript
|
|
118
|
+
- Commander.js (命令行解析)
|
|
119
|
+
- Inquirer.js (交互式提示)
|
|
120
|
+
- Ora (加载动画)
|
|
121
|
+
- Chalk (终端颜色)
|
|
122
|
+
|
|
123
|
+
## 参与贡献
|
|
124
|
+
|
|
125
|
+
1. Fork 本仓库
|
|
126
|
+
2. 新建 Feat_xxx 分支
|
|
127
|
+
3. 提交代码
|
|
128
|
+
4. 新建 Pull Request
|
|
129
|
+
|
|
130
|
+
## 版本历史
|
|
131
|
+
- v0.0.3: 初始版本，支持基本的初始化和更新功能
|
|
132
|
+
|
|
133
|
+
## 许可证
|
|
134
|
+
ISC License
|
package/assets/bg.png
ADDED
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "bcoder",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3",
|
|
4
4
|
"description": "极轻量级的企业 AI Coding 助手：init 初始化项目与 AI 工具目录，update 同步 bcoder 模板",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"bin": {
|
|
@@ -15,12 +15,12 @@
|
|
|
15
15
|
"bin",
|
|
16
16
|
"dist",
|
|
17
17
|
"bcoder",
|
|
18
|
+
"assets",
|
|
18
19
|
"README.md"
|
|
19
20
|
],
|
|
20
21
|
"keywords": [
|
|
21
22
|
"cli",
|
|
22
23
|
"ai",
|
|
23
|
-
"cursor",
|
|
24
24
|
"coding",
|
|
25
25
|
"init"
|
|
26
26
|
],
|
package/README.en.md
DELETED
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
# bcoder
|
|
2
|
-
|
|
3
|
-
#### Description
|
|
4
|
-
best coder 一个极轻量级的AI Coder助手
|
|
5
|
-
|
|
6
|
-
#### Software Architecture
|
|
7
|
-
Software architecture description
|
|
8
|
-
|
|
9
|
-
#### Installation
|
|
10
|
-
|
|
11
|
-
1. xxxx
|
|
12
|
-
2. xxxx
|
|
13
|
-
3. xxxx
|
|
14
|
-
|
|
15
|
-
#### Instructions
|
|
16
|
-
|
|
17
|
-
1. xxxx
|
|
18
|
-
2. xxxx
|
|
19
|
-
3. xxxx
|
|
20
|
-
|
|
21
|
-
#### Contribution
|
|
22
|
-
|
|
23
|
-
1. Fork the repository
|
|
24
|
-
2. Create Feat_xxx branch
|
|
25
|
-
3. Commit your code
|
|
26
|
-
4. Create Pull Request
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
#### Gitee Feature
|
|
30
|
-
|
|
31
|
-
1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
|
|
32
|
-
2. Gitee blog [blog.gitee.com](https://blog.gitee.com)
|
|
33
|
-
3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
|
|
34
|
-
4. The most valuable open source project [GVP](https://gitee.com/gvp)
|
|
35
|
-
5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
|
|
36
|
-
6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
|