@devflow-tools/sdk 0.17.5 → 0.17.6

package/README.md

@@ -1,80 +1,43 @@
 # @devflow-tools/sdk
 
-DevFlow 共享 SDK — 类型定义、接口、工具函数、API 客户端和插件加载器。
+> DevFlow 公共类型、插件契约、API client、配置/日志工具和 embedding contract。（v0.17.6）
 
-## Installation
+[![npm version](https://img.shields.io/npm/v/%40devflow-tools%2Fsdk.svg)](https://www.npmjs.com/package/@devflow-tools/sdk)
+
+## 安装
 
 ```bash
 npm install @devflow-tools/sdk
 ```
 
-## Usage
+## 快速开始
 
 ```typescript
-import { DevFlowApiClient, loadPlugins, countTokens } from '@devflow-tools/sdk';
-
-// API 客户端
-const client = new DevFlowApiClient({
-  baseUrl: 'http://localhost:13337',
-  apiKey: process.env.DEVFLOW_API_KEY,
-  projectRoot: '/path/to/project',
-});
+import { countTokens, loadPlugins } from '@devflow-tools/sdk';
 
-// 加载插件
-const plugins = await loadPlugins('/path/to/project');
+console.log(countTokens('hello'));
+const plugins = await loadPlugins(process.cwd());
 ```
 
-## Exports
+## 公共 API / 命令
 
-### Types
+根入口包含 `DevFlowApiClient`、`DevFlowPlugin`、`EmbeddingProviderContract`、`loadConfig`、`loadPlugins`、`createLogger` 和 token 工具。引擎组合器位于 `@devflow-tools/context-engine`。
 
-| 导出 | 说明 |
-|------|------|
-| `DevFlowPlugin` | 插件接口（meta、knowledge、memory、tools、hooks） |
-| `KnowledgeSource` | 知识源定义（name、urls、pluginName、version、renderJs） |
-| `BenchmarkScenario` | 基准测试场景 |
-| `BenchmarkRunResult` | 基准测试运行结果 |
-| `BenchmarkReport` | 基准测试报告 |
-| `BenchmarkTask` | 基准测试任务 |
-| `ToolCallEvent` | Tool 调用事件 |
-| `WorkflowDefinition` | 工作流定义 |
-| `ContextResult` | 上下文检索结果 |
 
-### Classes & Functions
+## 配置与运行时
 
-| 导出 | 说明 |
-|------|------|
-| `DevFlowApiClient` | REST API 客户端，封装所有 Server 端点 |
-| `loadPlugins()` | 插件发现和加载 |
-| `createEngines(root)` | 初始化所有引擎（context、graph、memory、knowledge、telemetry） |
-| `countTokens(text)` | Token 计数工具 |
-| `loadConfig(root)` | 加载 `.devflow/config.json` |
-| `getProjectRoot()` | 检测项目根目录 |
-| `createLogger(name)` | 创建结构化日志器 |
+可用 subpath：`@devflow-tools/sdk/step-templates`、`/auth`、`/plugin-workflow`、`/capability-rollout`、`/utils/project-scanner`。SDK 只定义跨包契约，不依赖 memory/knowledge 实现。
 
-### Plugin Interface
+## 版本与兼容性
 
-```typescript
-interface DevFlowPlugin {
-  meta: {
-    name: string;
-    version: string;
-    description: string;
-    icon?: string;
-    tags?: string[];
-  };
-  knowledge?: {
-    sources: KnowledgeSource[];
-  };
-  memory?: {
-    project?: { stack?: string[]; conventions?: MemoryEntry[] };
-    global?: MemoryEntry[];
-    user?: MemoryEntry[];
-  };
-  tools?: MCPTool[];
-  hooks?: Record<string, HookHandler>;
-}
-```
+- 当前包版本：`0.17.6`
+- Node.js：未在 package manifest 声明更高版本时，使用 Node.js 18+；原生 SQLite/Playwright 能力请按对应依赖安装
+- workspace 内部包应使用同一 DevFlow minor/patch 版本，避免类型和数据库 schema 不一致
+
+## 相关链接
+
+- [DevFlow 仓库](https://github.com/shilongfeicool/dev-flow)
+- [问题反馈](https://github.com/shilongfeicool/dev-flow/issues)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devflow-tools/sdk",
-  "version": "0.17.5",
+  "version": "0.17.6",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -37,7 +37,7 @@
     "clean": "rm -rf dist"
   },
   "dependencies": {
-    "@devflow-tools/database": "0.17.4",
+    "@devflow-tools/database": "0.17.6",
     "tiktoken": "^1.0.0"
   },
   "devDependencies": {
@@ -47,5 +47,5 @@
   "files": [
     "dist"
   ],
-  "gitHead": "817b0286c249eed9c2bd27d3974ee3b3d6ded4bb"
+  "gitHead": "669fea3aa72aa3fde14ed50d24c1fec4dfac088f"
 }