@devflow-tools/server 0.17.5 → 0.17.7

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 (2) hide show
  1. package/README.md +30 -44
  2. package/package.json +11 -11
package/README.md CHANGED
@@ -1,59 +1,45 @@
1
1
  # @devflow-tools/server
2
2
 
3
- DevFlow REST API 服务端 — 平台后端核心。基于 NestJS + Fastify 构建。
3
+ > 基于 NestJS + Fastify 的 DevFlow REST API 服务端。（v0.17.7）
4
4
 
5
- ## Installation
5
+ [![npm version](https://img.shields.io/npm/v/%40devflow-tools%2Fserver.svg)](https://www.npmjs.com/package/@devflow-tools/server)
6
+
7
+ ## 安装
6
8
 
7
9
  ```bash
8
10
  npm install @devflow-tools/server
9
11
  ```
10
12
 
11
- ## Quick Start
13
+ ## 快速开始
12
14
 
13
15
  ```bash
14
- # 通过 CLI 启动
15
- npx devflow server start
16
-
17
- # 或直接启动
18
- node node_modules/@devflow-tools/server/dist/main.js
16
+ npm install -g @devflow-tools/cli
17
+ devflow server start
18
+ # 默认监听 http://127.0.0.1:13337
19
19
  ```
20
20
 
21
- 服务端启动在 `http://localhost:13337`，API 前缀 `/api`。
22
-
23
- ## API Modules
24
-
25
- | 模块 | 基础端点 | 说明 |
26
- |------|---------|------|
27
- | Projects | `/api/projects` | 项目 CRUD + Onboarding Pack |
28
- | Context | `/api/context/build` | 上下文检索（通用 / 任务模式） |
29
- | Context | `/api/context/feedback` | 上下文反馈（hit/partial/miss） |
30
- | Graph | `/api/graph` | 依赖图谱查询（节点展开、路径查询） |
31
- | Workflows | `/api/workflows/:type/run` | 工作流启动 + SSE 实时流 |
32
- | Workflows | `/api/workflows/runs/:id/approve` | 审批门禁（approve/reject） |
33
- | Memory | `/api/memory` | 项目记忆管理 |
34
- | Memory | `/api/memory/candidates/:id/approve` | 候选记忆审核 |
35
- | Memory | `/api/memory/session-events` | Session tool event 记录 |
36
- | Knowledge | `/api/knowledge/search` | 文档搜索 |
37
- | Knowledge | `/api/knowledge/sync` | 知识源同步 |
38
- | Knowledge | `/api/knowledge/sources` | 知识源状态查询 |
39
- | Telemetry | `/api/telemetry/executions` | Skill 执行历史 |
40
- | Telemetry | `/api/telemetry/mcp-compliance` | MCP 合规率统计 |
41
- | Telemetry | `/api/telemetry/roi-summary` | ROI 汇总 |
42
- | Telemetry | `/api/telemetry/cleanup` | 过期数据清理 |
43
- | Benchmark | `/api/benchmark/run` | 基准测试运行 |
44
- | Benchmark | `/api/benchmark/reports` | 报告列表 |
45
- | Registry | `/api/registry/plugins` | 插件注册与查询 |
46
-
47
- ## Authentication
48
-
49
- 除健康检查外，所有端点需要 `X-API-Key` 请求头。首次启动会生成 `~/.devflow/keys/local.key`（权限 400）。
50
-
51
- ## Environment Variables
52
-
53
- | 变量 | 默认值 | 说明 |
54
- |------|--------|------|
55
- | `DEVFLOW_API_KEYS` | 自动生成本地密钥 | 逗号分隔的 API 密钥列表 |
56
- | `PORT` | `13337` | 服务端口 |
21
+ ## 公共 API / 命令
22
+
23
+ binary `devflow-server`；提供 `/api/context`、`/api/graph`、`/api/workflows`、`/api/memory`、`/api/knowledge`、`/api/telemetry`、`/api/benchmark` 和 `/api/registry`。
24
+
25
+
26
+ 二进制入口：
27
+ - `devflow-server`
28
+
29
+ ## 配置与运行时
30
+
31
+ 除健康检查外要求 `X-API-Key`；`PORT` 默认 `13337`，`DEVFLOW_API_KEYS` 可配置允许的密钥列表。
32
+
33
+ ## 版本与兼容性
34
+
35
+ - 当前包版本：`0.17.7`
36
+ - Node.js：未在 package manifest 声明更高版本时，使用 Node.js 18+；原生 SQLite/Playwright 能力请按对应依赖安装
37
+ - workspace 内部包应使用同一 DevFlow minor/patch 版本，避免类型和数据库 schema 不一致
38
+
39
+ ## 相关链接
40
+
41
+ - [DevFlow 仓库](https://github.com/shilongfeicool/dev-flow)
42
+ - [问题反馈](https://github.com/shilongfeicool/dev-flow/issues)
57
43
 
58
44
  ## License
59
45
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@devflow-tools/server",
3
- "version": "0.17.5",
3
+ "version": "0.17.7",
4
4
  "type": "module",
5
5
  "main": "./dist/main.js",
6
6
  "bin": {
@@ -15,15 +15,15 @@
15
15
  "clean": "rm -rf dist"
16
16
  },
17
17
  "dependencies": {
18
- "@devflow-tools/adapters": "0.17.5",
19
- "@devflow-tools/benchmark": "0.17.5",
20
- "@devflow-tools/context-engine": "0.17.5",
21
- "@devflow-tools/database": "0.17.4",
22
- "@devflow-tools/knowledge-engine": "0.17.5",
23
- "@devflow-tools/memory-engine": "0.17.5",
24
- "@devflow-tools/sdk": "0.17.5",
25
- "@devflow-tools/telemetry": "0.17.5",
26
- "@devflow-tools/workflow-engine": "0.17.5",
18
+ "@devflow-tools/adapters": "0.17.7",
19
+ "@devflow-tools/benchmark": "0.17.7",
20
+ "@devflow-tools/context-engine": "0.17.7",
21
+ "@devflow-tools/database": "0.17.7",
22
+ "@devflow-tools/knowledge-engine": "0.17.7",
23
+ "@devflow-tools/memory-engine": "0.17.7",
24
+ "@devflow-tools/sdk": "0.17.7",
25
+ "@devflow-tools/telemetry": "0.17.7",
26
+ "@devflow-tools/workflow-engine": "0.17.7",
27
27
  "@fastify/static": "^7.0.4",
28
28
  "@nestjs/common": "^10.4.0",
29
29
  "@nestjs/core": "^10.4.0",
@@ -43,5 +43,5 @@
43
43
  "dist",
44
44
  "bin"
45
45
  ],
46
- "gitHead": "817b0286c249eed9c2bd27d3974ee3b3d6ded4bb"
46
+ "gitHead": "560fe8a097aa9d398fdcfec409134cc94d26f92f"
47
47
  }