Skip to content

Commit 3f21f55

Browse files
committed
docs(structure): 更新项目目录结构说明
- 新增 runtime、commands、kscli、e2e 和 bailian-kb-dsh 包说明 - 扩展 core 包功能描述,包含配置、错误等内容 - 明确 cli 包为完整产品入口 - 添加 skills 目录及对应功能说明 - 调整目录顺序,增强文档清晰度和完整性
1 parent eb8b089 commit 3f21f55

2 files changed

Lines changed: 22 additions & 10 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,17 @@ Developer guide for `bailian-cli` — the official CLI for Aliyun Model Studio (
1616
```
1717
bailian-cli/
1818
├── packages/
19-
│ ├── cli/ # `bailian-cli` — CLI entry, commands, UI
20-
│ └── core/ # `bailian-cli-core` — auth, HTTP, types
21-
├── docs/agents/ # Scenario-based maintenance guides
22-
├── tools/ # Release automation & reference generation
23-
├── AGENTS.md # Contract for AI agents
19+
│ ├── core/ # `bailian-cli-core` — auth, config, HTTP client, errors, types
20+
│ ├── runtime/ # `bailian-cli-runtime` — CLI framework: parsing, help, middleware, output
21+
│ ├── commands/ # `bailian-cli-commands` — reusable command implementations
22+
│ ├── cli/ # `bailian-cli` — the full `bl` product entry
23+
│ ├── kscli/ # `knowledge-studio-cli` — `kscli` entry, reuses commands/
24+
│ ├── e2e/ # Shared e2e harness utilities (private)
25+
│ └── bailian-kb-dsh/ # `bailian-kb-dsh` — DeepSeek Harness plugin (independent version & release)
26+
├── skills/ # Agent skills installed by `bl skill init`
27+
├── docs/agents/ # Scenario-based maintenance guides
28+
├── tools/ # Release automation & reference generation
29+
├── AGENTS.md # Contract for AI agents
2430
└── README.md
2531
```
2632

CONTRIBUTING.zh.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,17 @@
1616
```
1717
bailian-cli/
1818
├── packages/
19-
│ ├── cli/ # `bailian-cli` —— CLI 入口、命令、UI
20-
│ └── core/ # `bailian-cli-core` —— 鉴权、HTTP、类型
21-
├── docs/agents/ # 场景化维护文档
22-
├── tools/ # 发版自动化与命令手册生成
23-
├── AGENTS.md # AI agent 维护契约
19+
│ ├── core/ # `bailian-cli-core` —— 鉴权、配置、HTTP client、错误、类型
20+
│ ├── runtime/ # `bailian-cli-runtime` —— CLI 运行时:参数解析、help、middleware、输出
21+
│ ├── commands/ # `bailian-cli-commands` —— 可复用命令实现库
22+
│ ├── cli/ # `bailian-cli` —— 完整 `bl` 产品入口
23+
│ ├── kscli/ # `knowledge-studio-cli` —— `kscli` 入口,复用 commands/
24+
│ ├── e2e/ # e2e 共享工具(不发布)
25+
│ └── bailian-kb-dsh/ # `bailian-kb-dsh` —— DeepSeek Harness 插件(版本与发布独立)
26+
├── skills/ # `bl skill init` 安装的 Agent skill
27+
├── docs/agents/ # 场景化维护文档
28+
├── tools/ # 发版自动化与命令手册生成
29+
├── AGENTS.md # AI agent 维护契约
2430
└── README.md
2531
```
2632

0 commit comments

Comments
 (0)