dwf-platform-cli 0.2.0__py3-none-any.whl

dwf_cli/schemas/funcmodel/operations_create.schema.json

@@ -0,0 +1,77 @@
+{
+  "description": "新增快速查询操作。oprScript/extSettings/viewType 传 JSON 对象自动转字符串",
+  "api": "POST /dwf/v1/meta/queryoperations-create (param: autoGenerateName)",
+  "type": "object",
+  "fields": [
+    {"name": "displayName", "type": "string", "required": true, "description": "操作显示名称（中文名），最长32字符", "example": "创建用户"},
+    {"name": "moduleName", "type": "string", "required": true, "description": "所属模块类英文名（className）", "example": "UserModule"},
+    {"name": "action", "type": "string", "required": true, "description": "操作类型，决定行为模式", "enum": ["create", "next_create", "edit", "visit", "url", "implement", "global_implement", "list", "folder"], "example": "create"},
+    {"name": "authority", "type": "string", "required": true, "description": "操作权限标识（英文名）。编辑时作为唯一标识，新增时可由后端 autoGenerateName 自动生成", "example": "createUser"},
+    {"name": "conType", "type": "string", "required": true, "description": "操作展现形式（容器类型）", "enum": ["dialog", "drawerR", "drawerL", "drawerT", "drawerB", "tab", "tip", "page"], "example": "dialog"},
+    {"name": "targetClass", "type": "string", "required": false, "description": "目标类全名（goal）。action=create/edit/visit/next_create 时必填", "example": "com.example.model.User"},
+    {"name": "viewOid", "type": "string", "required": false, "description": "表单视图OID。viewName='*' 时为 null（默认表单）。action=create/edit/visit/next_create 时必填", "example": "view-oid-12345"},
+    {"name": "viewName", "type": "string", "required": false, "description": "表单视图名称。viewOid 为 null 时设为 '*' 兼容旧数据", "example": "userForm"},
+    {"name": "viewTitle", "type": "string", "required": false, "description": "弹窗标题/视图标题", "example": "创建用户"},
+    {"name": "icon", "type": "string", "required": false, "description": "系统图标名称（btmIconType='系统图标'时使用）", "example": "ios-cube-outline"},
+    {"name": "order", "type": "number", "required": false, "description": "排序编号，控制菜单显示顺序", "default": 0, "example": 1},
+    {"name": "params", "type": "string", "required": false, "description": "参数配置，拼接前后置脚本参数", "example": "APP_beforeScript:console.log('before')APP_afterScript:console.log('after')"},
+    {"name": "conditionExpre", "type": "string", "required": false, "description": "条件表达式。action=url 时存链接URL；action=implement/global_implement 时存插件路径('addin:'前缀)；其余存查询条件", "example": "status=1"},
+    {"name": "parentOprId", "type": "string", "required": false, "description": "父节点操作ID"},
+    {"name": "isHidden", "type": "boolean", "required": false, "description": "是否在菜单中隐藏", "default": false, "example": false},
+    {"name": "implementType", "type": "string", "required": false, "description": "实现方式类型（action=implement/global_implement 时必填）", "enum": ["", "addin", "serverScript", "clientScript"]},
+    {"name": "oprScript", "type": "object", "required": false, "description": "脚本配置（自动转 JSON 字符串），含 implement/appBefore/appAfter/appClose 四组"},
+    {"name": "oprScript.implement", "type": "object", "required": false, "description": "实现脚本，含 entry/client/server"},
+    {"name": "oprScript.appBefore", "type": "object", "required": false, "description": "前置脚本"},
+    {"name": "oprScript.appAfter", "type": "object", "required": false, "description": "后置脚本"},
+    {"name": "oprScript.appClose", "type": "object", "required": false, "description": "关闭脚本"},
+    {"name": "extSettings", "type": "object", "required": false, "description": "扩展设置（自动转 JSON 字符串），含按钮行为、刷新策略等"},
+    {"name": "extSettings.needDefaultOpr", "type": "boolean", "required": false, "description": "是否需要默认操作按钮（保存/取消）", "default": false},
+    {"name": "extSettings.backRefresh", "type": "boolean", "required": false, "description": "操作完成后是否返回刷新", "default": true},
+    {"name": "extSettings.sourceFormFreshStatus", "type": "boolean", "required": false, "description": "源表单是否刷新", "default": false},
+    {"name": "extSettings.targetFormFreshStatus", "type": "boolean", "required": false, "description": "目标表单是否刷新", "default": true},
+    {"name": "extSettings.needDialogDefaultOpr", "type": "boolean", "required": false, "description": "弹窗是否需要默认操作按钮", "default": true},
+    {"name": "extSettings.autoClose", "type": "string", "required": false, "description": "自动关闭策略", "enum": ["auto", "manual"], "default": "auto"},
+    {"name": "extSettings.sysBindOpr", "type": "boolean", "required": false, "description": "是否为系统绑定操作", "default": false},
+    {"name": "extSettings.btmIconType", "type": "string", "required": false, "description": "底部图标类型", "enum": ["系统图标", "自定义图标"], "default": "系统图标"},
+    {"name": "extSettings.btmIconDefColor", "type": "string", "required": false, "description": "底部图标默认颜色", "default": "#646566"},
+    {"name": "extSettings.btmIconActColor", "type": "string", "required": false, "description": "底部图标激活颜色", "default": "#1989fa"},
+    {"name": "extSettings.defImg", "type": "string", "required": false, "description": "自定义默认图标文件ID"},
+    {"name": "extSettings.actImg", "type": "string", "required": false, "description": "自定义选中图标文件ID"},
+    {"name": "viewType", "type": "object", "required": false, "description": "弹窗参数配置（自动转 JSON 字符串），含尺寸、位置、拖拽等"},
+    {"name": "viewType.needPopTitle", "type": "boolean", "required": false, "description": "是否需要弹窗标题", "default": false},
+    {"name": "viewType.popTitleTxt", "type": "string", "required": false, "description": "弹窗标题文字", "default": "提示"},
+    {"name": "viewType.popTitleFs", "type": "number", "required": false, "description": "弹窗标题字号(px)", "default": 14},
+    {"name": "viewType.popTitleColor", "type": "string", "required": false, "description": "弹窗标题颜色", "default": "#333"},
+    {"name": "viewType.tipPlacement", "type": "string", "required": false, "description": "tip提示位置（conType='tip'时使用）", "enum": ["左边", "右边", "上边", "下边"], "default": "右边"},
+    {"name": "viewType.popWidth", "type": "number", "required": false, "description": "tip弹窗宽度(px)", "default": 400},
+    {"name": "viewType.dialogWidth", "type": "number", "required": false, "description": "弹窗宽度数值", "default": 86},
+    {"name": "viewType.dialogWidthType", "type": "string", "required": false, "description": "弹窗宽度单位", "enum": ["%", "px"], "default": "%"},
+    {"name": "viewType.dialogAutoHeight", "type": "boolean", "required": false, "description": "弹窗是否自动高度", "default": true},
+    {"name": "viewType.dialogHeight", "type": "number", "required": false, "description": "弹窗高度数值", "default": 400},
+    {"name": "viewType.dialogHeightType", "type": "string", "required": false, "description": "弹窗高度单位", "enum": ["px", "%"], "default": "px"},
+    {"name": "viewType.dragDialog", "type": "boolean", "required": false, "description": "弹窗是否可拖拽", "default": false},
+    {"name": "viewType.drawerWidth", "type": "number", "required": false, "description": "抽屉宽度(px)", "default": 720},
+    {"name": "viewType.drawerWidthType", "type": "string", "required": false, "description": "抽屉宽度单位", "enum": ["px", "%"], "default": "px"},
+    {"name": "viewType.drawerHeight", "type": "number", "required": false, "description": "抽屉高度数值", "default": 100},
+    {"name": "viewType.drawerHeightType", "type": "string", "required": false, "description": "抽屉高度单位", "enum": ["%", "px"], "default": "%"}
+  ],
+  "examples": [
+    {
+      "displayName": "创建用户",
+      "moduleName": "UserModule",
+      "action": "create",
+      "authority": "createUser",
+      "conType": "dialog",
+      "targetClass": "com.example.model.User",
+      "viewOid": "view-oid-12345",
+      "oprScript": {
+        "implement": {"entry": "client", "client": {"default": {"script": "console.log('hi')"}}, "server": {"default": {"script": "", "displayName": "默认脚本"}}}
+      },
+      "extSettings": {"needDefaultOpr": false, "autoClose": "auto", "btmIconType": "系统图标"},
+      "viewType": {"dialogWidth": 86, "dialogWidthType": "%", "dialogAutoHeight": true},
+      "icon": "ios-cube-outline",
+      "order": 1,
+      "isHidden": false
+    }
+  ]
+}

dwf_cli/schemas/funcmodel/operations_update.schema.json

@@ -0,0 +1,76 @@
+{
+  "description": "更新快速查询操作。oprScript/extSettings/viewType 传 JSON 对象自动转字符串",
+  "api": "POST /dwf/v1/meta/queryoperations-update (param: forceUpdate)",
+  "type": "object",
+  "fields": [
+    {"name": "oid", "type": "string", "required": true, "description": "操作OID（必填，标识要更新的操作）", "example": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6"},
+    {"name": "displayName", "type": "string", "required": false, "description": "操作显示名称（中文名），最长32字符", "example": "创建用户"},
+    {"name": "moduleName", "type": "string", "required": false, "description": "所属模块类英文名", "example": "UserModule"},
+    {"name": "action", "type": "string", "required": false, "description": "操作类型", "enum": ["create", "next_create", "edit", "visit", "url", "implement", "global_implement", "list", "folder"]},
+    {"name": "authority", "type": "string", "required": false, "description": "操作权限标识（英文名）", "example": "createUser"},
+    {"name": "conType", "type": "string", "required": false, "description": "操作展现形式", "enum": ["dialog", "drawerR", "drawerL", "drawerT", "drawerB", "tab", "tip", "page"]},
+    {"name": "targetClass", "type": "string", "required": false, "description": "目标类全名", "example": "com.example.model.User"},
+    {"name": "viewOid", "type": "string", "required": false, "description": "表单视图OID"},
+    {"name": "viewName", "type": "string", "required": false, "description": "表单视图名称"},
+    {"name": "viewTitle", "type": "string", "required": false, "description": "弹窗标题"},
+    {"name": "icon", "type": "string", "required": false, "description": "系统图标名称"},
+    {"name": "order", "type": "number", "required": false, "description": "排序编号", "default": 0},
+    {"name": "params", "type": "string", "required": false, "description": "参数配置字符串"},
+    {"name": "conditionExpre", "type": "string", "required": false, "description": "条件表达式"},
+    {"name": "parentOprId", "type": "string", "required": false, "description": "父节点操作ID"},
+    {"name": "isHidden", "type": "boolean", "required": false, "description": "是否在菜单中隐藏", "default": false},
+    {"name": "implementType", "type": "string", "required": false, "description": "实现方式类型", "enum": ["", "addin", "serverScript", "clientScript"]},
+    {"name": "modifyTime", "type": "string", "required": false, "description": "最后修改时间，回传以检测并发冲突", "example": "2024-01-15T10:30:00"},
+    {"name": "oprScript", "type": "object", "required": false, "description": "脚本配置（自动转 JSON 字符串）"},
+    {"name": "oprScript.implement", "type": "object", "required": false, "description": "实现脚本"},
+    {"name": "oprScript.appBefore", "type": "object", "required": false, "description": "前置脚本"},
+    {"name": "oprScript.appAfter", "type": "object", "required": false, "description": "后置脚本"},
+    {"name": "oprScript.appClose", "type": "object", "required": false, "description": "关闭脚本"},
+    {"name": "extSettings", "type": "object", "required": false, "description": "扩展设置（自动转 JSON 字符串）"},
+    {"name": "extSettings.needDefaultOpr", "type": "boolean", "required": false, "description": "是否需要默认操作按钮", "default": false},
+    {"name": "extSettings.backRefresh", "type": "boolean", "required": false, "description": "操作完成后是否返回刷新", "default": true},
+    {"name": "extSettings.sourceFormFreshStatus", "type": "boolean", "required": false, "description": "源表单是否刷新", "default": false},
+    {"name": "extSettings.targetFormFreshStatus", "type": "boolean", "required": false, "description": "目标表单是否刷新", "default": true},
+    {"name": "extSettings.needDialogDefaultOpr", "type": "boolean", "required": false, "description": "弹窗是否需要默认操作按钮", "default": true},
+    {"name": "extSettings.autoClose", "type": "string", "required": false, "description": "自动关闭策略", "enum": ["auto", "manual"], "default": "auto"},
+    {"name": "extSettings.sysBindOpr", "type": "boolean", "required": false, "description": "是否为系统绑定操作", "default": false},
+    {"name": "extSettings.btmIconType", "type": "string", "required": false, "description": "底部图标类型", "enum": ["系统图标", "自定义图标"], "default": "系统图标"},
+    {"name": "extSettings.btmIconDefColor", "type": "string", "required": false, "description": "底部图标默认颜色", "default": "#646566"},
+    {"name": "extSettings.btmIconActColor", "type": "string", "required": false, "description": "底部图标激活颜色", "default": "#1989fa"},
+    {"name": "extSettings.defImg", "type": "string", "required": false, "description": "自定义默认图标文件ID"},
+    {"name": "extSettings.actImg", "type": "string", "required": false, "description": "自定义选中图标文件ID"},
+    {"name": "viewType", "type": "object", "required": false, "description": "弹窗参数配置（自动转 JSON 字符串）"},
+    {"name": "viewType.needPopTitle", "type": "boolean", "required": false, "description": "是否需要弹窗标题", "default": false},
+    {"name": "viewType.popTitleTxt", "type": "string", "required": false, "description": "弹窗标题文字", "default": "提示"},
+    {"name": "viewType.popTitleFs", "type": "number", "required": false, "description": "弹窗标题字号(px)", "default": 14},
+    {"name": "viewType.popTitleColor", "type": "string", "required": false, "description": "弹窗标题颜色", "default": "#333"},
+    {"name": "viewType.tipPlacement", "type": "string", "required": false, "description": "tip提示位置", "enum": ["左边", "右边", "上边", "下边"], "default": "右边"},
+    {"name": "viewType.popWidth", "type": "number", "required": false, "description": "tip弹窗宽度(px)", "default": 400},
+    {"name": "viewType.dialogWidth", "type": "number", "required": false, "description": "弹窗宽度数值", "default": 86},
+    {"name": "viewType.dialogWidthType", "type": "string", "required": false, "description": "弹窗宽度单位", "enum": ["%", "px"], "default": "%"},
+    {"name": "viewType.dialogAutoHeight", "type": "boolean", "required": false, "description": "弹窗是否自动高度", "default": true},
+    {"name": "viewType.dialogHeight", "type": "number", "required": false, "description": "弹窗高度数值", "default": 400},
+    {"name": "viewType.dialogHeightType", "type": "string", "required": false, "description": "弹窗高度单位", "enum": ["px", "%"], "default": "px"},
+    {"name": "viewType.dragDialog", "type": "boolean", "required": false, "description": "弹窗是否可拖拽", "default": false},
+    {"name": "viewType.drawerWidth", "type": "number", "required": false, "description": "抽屉宽度(px)", "default": 720},
+    {"name": "viewType.drawerWidthType", "type": "string", "required": false, "description": "抽屉宽度单位", "enum": ["px", "%"], "default": "px"},
+    {"name": "viewType.drawerHeight", "type": "number", "required": false, "description": "抽屉高度数值", "default": 100},
+    {"name": "viewType.drawerHeightType", "type": "string", "required": false, "description": "抽屉高度单位", "enum": ["%", "px"], "default": "%"}
+  ],
+  "examples": [
+    {
+      "oid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6",
+      "displayName": "编辑用户（改名）",
+      "modifyTime": "2024-01-15T10:30:00"
+    },
+    {
+      "oid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6",
+      "isHidden": true
+    },
+    {
+      "oid": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6",
+      "extSettings": {"needDefaultOpr": true, "autoClose": "manual"},
+      "viewType": {"dialogWidth": 90, "dialogWidthType": "%"}
+    }
+  ]
+}

dwf_platform_cli-0.2.0.dist-info/METADATA

@@ -0,0 +1,347 @@
+Metadata-Version: 2.4
+Name: dwf-platform-cli
+Version: 0.2.0
+Summary: DWF platform CLI and MCP server for AI agents and developers
+Project-URL: Repository, https://gitee.com/tsinghua-nercbds/dwf-cli
+Project-URL: Documentation, https://gitee.com/tsinghua-nercbds/dwf-cli#readme
+Project-URL: Issues, https://gitee.com/tsinghua-nercbds/dwf-cli/issues
+Author-email: nercbds dwf group <csliuyb@qq.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai-agent,cli,dwf,llm-tools,mcp
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: pycryptodome>=3.23.0
+Requires-Dist: pypinyin>=0.52.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.25.1
+Description-Content-Type: text/markdown
+
+# DWF-CLI
+
+DWF（Digital Workflow）平台命令行工具，通过 REST API 与 DWF 后端交互，为 AI 智能体和开发人员提供数据模型查询、数据操作、认证管理等功能。
+
+## 功能
+
+- **用户认证** — 登录/登出/状态查询（AES 加密密码传输）
+- **数据模型管理** — 查询/创建/更新/删除实体类、关联类、外部实体类及其属性
+- **数据操作** — 对象数据的增删改查（CRUD），支持 `--if-not-exists` 幂等创建
+- **高级查询** — 对象列表支持 `refs`（关联字段拉平）和 `options`（嵌套子查询）
+- **Excel 快速建表** — 上传 Excel 一键完成建表和数据导入
+- **功能模型** — 应用管理、全局操作列表
+- **表单模型** — 视图的查询/创建/更新/删除
+- **Schema 自省** — `dwf-cli schema` 查看命令参数定义，`--validate` 校验输入
+- **配置管理** — 服务器地址、AES 密钥等配置项管理
+
+## 快速开始
+
+### 环境要求
+
+- Python 3.12+
+- [uv](https://docs.astral.sh/uv/) 包管理器
+
+### 安装
+
+```bash
+# 安装（推荐 uv tool）
+uv tool install dwf-cli
+
+# 或从源码安装
+git clone https://gitee.com/tsinghua-nercbds/dwf-cli.git
+cd dwf-cli
+uv tool install .
+```
+
+### 配置与登录
+
+```bash
+# 方式一：自动检测（推荐，从 DWF 服务获取配置）
+dwf-cli config detect http://your-dwf-server:6060 --save
+
+# 方式二：手动配置
+dwf-cli config set server http://your-dwf-server:6060
+dwf-cli config set app_server http://your-dwf-server:9090
+
+# 登录（TTY 模式交互输入密码）
+dwf-cli auth login --username admin
+
+# 非 TTY 模式（CI / AI agent）
+echo 'password' > /tmp/pw && dwf-cli auth login --username admin --password-file /tmp/pw
+
+# 查看登录状态
+dwf-cli auth status
+```
+
+### 使用示例
+
+```bash
+# 查询实体类列表
+dwf-cli datamodel list
+dwf-cli datamodel list -p 1 -s 10
+
+# 查询关联类 / 外部实体类
+dwf-cli datamodel list -t r
+dwf-cli datamodel list -t x
+
+# 包含系统类
+dwf-cli datamodel list --system
+
+# 查看某个类的属性
+dwf-cli datamodel show User
+dwf-cli datamodel show Animate -f json
+
+# 创建实体类（支持 --type entity|relation|external）
+dwf-cli datamodel create --data '[{"className":"TestClass","displayName":"测试类"}]'
+dwf-cli datamodel create -t relation --data '[{"className":"UserAsset","leftClass":"User","rightClass":"Asset"}]'
+dwf-cli datamodel create -t external --external-mode sql --file ext.json
+
+# 更新类信息
+dwf-cli datamodel update --data '{"id":"ABC123","displayName":"新名称"}'
+dwf-cli datamodel update -t external --data '{"id":"EXT123","displayName":"新名称"}'
+
+# 属性管理
+dwf-cli datamodel attribute list --keyword name
+dwf-cli datamodel attribute create --data '[{"attributeName":"phone","valueType":"String"}]'
+dwf-cli datamodel attribute bind -c User --data '[{"attributeName":"phone"}]'
+
+# 对象数据操作
+dwf-cli datamodel object list -c User -p 0
+dwf-cli datamodel object get <oid> -c User
+dwf-cli datamodel object create -c User --data '{"name":"test"}'
+dwf-cli datamodel object create -c User --data '{"name":"test"}' --if-not-exists
+
+# 对象高级查询（refs 关联字段拉平）
+dwf-cli datamodel object list -c Animate --file query.json
+
+# Excel 一键建表
+dwf-cli datamodel excel-quickstart template.xlsx
+
+# Schema 自省
+dwf-cli schema --all
+dwf-cli schema datamodel create
+
+# 功能模型
+dwf-cli funcmodel app list
+dwf-cli funcmodel operations list
+
+# 表单模型
+dwf-cli formmodel view list -c User
+dwf-cli formmodel view create -c User --name myView
+
+# 配置管理
+dwf-cli config list
+dwf-cli config get server
+dwf-cli config set aes_key "your-key"
+```
+
+## 文档
+
+完整文档使用 MkDocs + Material 主题构建：
+
+```bash
+# 本地预览（默认不含 API 参考文档，构建更快）
+uv run mkdocs serve
+
+# 包含 API 参考文档
+DWF_INCLUDE_API_DOCS=1 uv run mkdocs serve
+
+# 重新生成 API 文档（从 OpenAPI JSON）
+uv run python scripts/openapi_to_md.py
+```
+
+文档站点自动部署至 Tomcat（通过 Jenkinsfile CI）。
+
+## 架构
+
+项目采用三层分离架构：
+
+```
+cli/  →  api/  →  core/
+```
+
+- **`cli/`** — CLI 层：Typer 命令定义、参数解析、Rich 表格输出
+- **`api/`** — API 层：DWF 后端 REST API 的 Python SDK（httpx）
+- **`core/`** — 基础设施层：配置管理、AES 加密、错误定义、输出格式化
+
+依赖方向严格单向：`cli → api → core`，禁止反向依赖。
+
+详细架构设计见 [ARCHITECTURE.md](ARCHITECTURE.md)。
+
+## 项目结构
+
+```
+src/dwf_cli/
+├── __init__.py           # 入口点 (dwf-cli = "dwf_cli:app")
+├── __main__.py           # python -m dwf_cli
+├── api/                  # DWF 后端 REST SDK
+│   ├── client.py         # HTTP 客户端（baseURL、token 注入、错误映射）
+│   ├── auth.py           # 认证接口
+│   ├── datamodel.py      # 数据模型 + 对象 CRUD 接口
+│   ├── funcmodel.py      # 功能模型接口
+│   └── formmodel.py      # 表单模型接口
+├── cli/                  # Typer 命令
+│   ├── __init__.py       # 命令注册 + 上下文初始化（双 client：modeler + app）
+│   ├── _common.py        # 共享工具（ContextObj、get_client、get_app_client）
+│   ├── auth.py           # dwf-cli auth {login, logout, status}
+│   ├── datamodel.py      # dwf-cli datamodel {list, show, object CRUD}
+│   ├── funcmodel.py      # dwf-cli funcmodel {app, operations}
+│   ├── formmodel.py      # dwf-cli formmodel {view}
+│   └── config.py         # dwf-cli config {get, set, list, detect}
+├── mcp/                  # MCP Server（供 AI 工具直接集成）
+│   ├── __init__.py
+│   └── server.py         # FastMCP server，入口点 dwf-cli-mcp
+└── core/                 # 基础设施
+    ├── config.py         # 配置管理（JSON 持久化）+ config.js 解析
+    ├── crypto.py         # AES 密码加密
+    ├── errors.py         # 异常层级 + 退出码
+    └── output.py         # Rich 表格/JSON 输出
+```
+
+## 开发
+
+### 添加新命令
+
+只需 3 步：
+
+1. 新建 `src/dwf_cli/api/xxx.py` — 定义 API 调用函数
+2. 新建 `src/dwf_cli/cli/xxx.py` — 定义 Typer 命令
+3. 编辑 `src/dwf_cli/cli/__init__.py` — 添加 `app.add_typer()`
+
+### 开发命令
+
+```bash
+uv run dwf-cli --help              # 开发时运行 CLI
+uv run pytest -v                   # 运行测试
+uv run ruff check .                # 代码检查
+uv run ruff format .               # 代码格式化
+uv add <package>                   # 添加依赖
+```
+
+安装后直接使用：
+
+```bash
+dwf-cli --help                     # 已安装环境直接调用
+```
+
+### 文档命令
+
+```bash
+uv run mkdocs serve                # 本地预览文档
+DWF_INCLUDE_API_DOCS=1 uv run mkdocs serve  # 含 API 参考
+uv run python scripts/openapi_to_md.py       # 重新生成 API 文档
+```
+
+## 技术栈
+
+- [Typer](https://typer.tiangolo.com/) — CLI 框架
+- [httpx](https://www.python-httpx.org/) — HTTP 客户端
+- [Rich](https://rich.readthedocs.io/) — 终端美化输出
+- [MCP Python SDK](https://github.com/modelcontextprotocol/python-sdk) — MCP Server 实现
+- [pycryptodome](https://www.pycryptodome.org/) — AES 密码加密
+- [uv](https://docs.astral.sh/uv/) — 包管理器
+- [pytest](https://docs.pytest.org/) — 测试框架
+- [Ruff](https://docs.astral.sh/ruff/) — 代码检查与格式化
+
+## AI Agent 集成
+
+DWF-CLI 提供两种方式供 AI 编程工具使用：
+
+### 方式一：CLI 命令（所有 AI 工具通用）
+
+AI 编程工具（Claude Code、OpenCode、Codex 等）可通过 bash 直接调用 `dwf-cli` 命令。
+
+在你的项目 `AGENTS.md`（opencode）或 `CLAUDE.md`（Claude Code）中添加以下内容：
+
+```markdown
+## DWF CLI
+Use `dwf-cli` to interact with the DWF platform.
+- Run `dwf-cli schema --all` to get full command + parameter reference as JSON
+- Run `dwf-cli <command> --help` for specific command usage
+- Always use `--format json` for output parsing
+- Use `--data` for inline JSON, `--file` for file input
+- Use `--dry-run` to preview before executing
+- Setup: `dwf-cli config detect <url> --save` then `dwf-cli auth login --username <user>` (TTY) or `--password-file` (non-interactive)
+```
+
+### 方式二：MCP Server（深度集成，推荐）
+
+MCP (Model Context Protocol) 让 AI 工具直接调用 DWF 功能，无需拼 shell 命令。
+
+**安装后配置：**
+
+Claude Code (`~/.claude/settings.json`)：
+
+```json
+{
+  "mcpServers": {
+    "dwf": {
+      "command": "uvx",
+      "args": ["dwf-cli-mcp"]
+    }
+  }
+}
+```
+
+Cursor / Windsurf (`.cursor/mcp.json`)：
+
+```json
+{
+  "mcpServers": {
+    "dwf": {
+      "command": "uvx",
+      "args": ["dwf-cli-mcp"]
+    }
+  }
+}
+```
+
+从源码运行：
+
+```json
+{
+  "mcpServers": {
+    "dwf": {
+      "command": "uv",
+      "args": ["--directory", "/path/to/dwf-cli", "run", "dwf-cli-mcp"]
+    }
+  }
+}
+```
+
+**提供的 MCP 工具：**
+
+| 工具 | 说明 |
+|------|------|
+| `dwf_auth_status` | 检查认证状态 |
+| `dwf_config_list` | 查看配置 |
+| `dwf_datamodel_list` | 列出数据模型 |
+| `dwf_datamodel_show` | 查看模型详情 |
+| `dwf_datamodel_create` | 创建数据模型 |
+| `dwf_datamodel_delete` | 删除数据模型 |
+| `dwf_attribute_list` | 列出属性 |
+| `dwf_attribute_create` | 创建属性 |
+| `dwf_attribute_bind` | 绑定属性到模型 |
+| `dwf_object_list` | 列出对象 |
+| `dwf_object_get` | 获取单个对象 |
+| `dwf_object_create` | 创建对象 |
+| `dwf_object_update` | 更新对象 |
+| `dwf_object_delete` | 删除对象 |
+| `dwf_object_count` | 统计对象数量 |
+| `dwf_funcmodel_app_list` | 列出应用 |
+| `dwf_funcmodel_operation_list` | 列出功能操作 |
+| `dwf_formmodel_view_list` | 列出表单视图 |
+
+## License
+
+Apache-2.0

dwf_platform_cli-0.2.0.dist-info/RECORD

@@ -0,0 +1,47 @@
+dwf_cli/__init__.py,sha256=UAdh062wQFcGEMLvFCiqZpasYSDcJB3skX0rRTCfXVc,47
+dwf_cli/__main__.py,sha256=gkYwh4gwBPoucIh514AytZHHVaGfqjn0S4GLS1e5_LQ,85
+dwf_cli/api/__init__.py,sha256=a8AHEF8qoCCVNe-fOdgFP0ag5JN93gkDYJyKIPyJ11A,66
+dwf_cli/api/auth.py,sha256=N4BBeG1YrYYGiYpS5Cfs7vZN3ihlM-08PixTr5KqiUE,1171
+dwf_cli/api/client.py,sha256=Qh3cEyS5f6g5H8secxSvZ_3bCFkxslAf5h8WpTVoJdk,3441
+dwf_cli/api/datamodel.py,sha256=a2KRAwPTJ-pP_gXkvMLO_LvHPmFnQf7bVXLKd6JZcnA,10713
+dwf_cli/api/formmodel.py,sha256=Pp2SGluLrGHONWSPRg2WRF90KSm6WW6RWpx3P2VsKJM,4336
+dwf_cli/api/funcmodel.py,sha256=E2muMWBQ2dNagZIiHciw-OmEBUpVoNL7bcM1IfJUT4E,13020
+dwf_cli/cli/__init__.py,sha256=1y9lrc-uiy0elIRRSvwBzPR3FITpGxNfENDuFSchayQ,1905
+dwf_cli/cli/_common.py,sha256=X3EH_TVlBpKrYV3S9VZl5i7id2B0ZGRX65Ah7PNp5Ns,3787
+dwf_cli/cli/auth.py,sha256=0LsEDu5hsVMI3iqUUrPnrgWZAyzt6AT9LuyuNKrdnWc,5749
+dwf_cli/cli/config.py,sha256=4BES0242YjZQ0c1Y2LUD8fpILp4vjT1SPppq03or-SU,6407
+dwf_cli/cli/datamodel.py,sha256=rC-SOUSCE0xlpdLrR_PESSdgYlJl3idppvWgFX6AYP0,76519
+dwf_cli/cli/formmodel.py,sha256=0vNLkc5qfZCH6kWzZa2bGSJhky-qscTYSh4dVPfF-sk,31642
+dwf_cli/cli/funcmodel.py,sha256=VxcjQE9lLnXfj0PsKG4kAvWQ0Ot8QEeMujziNIPvOyU,70364
+dwf_cli/cli/schema.py,sha256=SzpvYaeDgkzUr5nlxiZ9jvkLZI2mQTxJUb7QRDcYNt4,6332
+dwf_cli/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dwf_cli/core/config.py,sha256=pvCpmLjnlnJQOPAPl0XNjGPrZJ77lxK1U14JstpBg6A,5502
+dwf_cli/core/crypto.py,sha256=QTVn2aiUC9UvNqUV-En1DY2set-sZbDboTzqJmDR7bw,804
+dwf_cli/core/errors.py,sha256=KRUN4Q2nPaUMdJuc0GqwKOCWpX2v74b_q6uIvfFn3t4,1643
+dwf_cli/core/output.py,sha256=UBaNoN3VCukCpz9lvUHUBU-aUbz6NoTodOp8nINOyuc,93
+dwf_cli/core/validator.py,sha256=MbsPZaH0UYwEwjIXnVKx5iXAGVUgmKPjKFS0HIO3XtE,3822
+dwf_cli/mcp/__init__.py,sha256=Tu0R5iU_ZW8i9XKkc8baqi0Vbtu6gjZUCPQaCenfOR8,54
+dwf_cli/mcp/server.py,sha256=N2_0Vtp7DpU8EgHXj1IM64VSDdt6MhVCkRVtn3HtaKk,11550
+dwf_cli/schemas/__init__.py,sha256=DgGtwPEoW1WI593u4Lt4Ile0yfWCvBmhe2tn52Qx10g,982
+dwf_cli/schemas/datamodel/attribute_bind.schema.json,sha256=g-ATHDmi-KcYLU6pqb_6n5YE-9gSlSJEdoQhvuFncBQ,1702
+dwf_cli/schemas/datamodel/attribute_create.schema.json,sha256=sTwxPQxpdQbDC1fDZKtiDIX8IJ9bCL_u3GBJzTjNAtk,1930
+dwf_cli/schemas/datamodel/attribute_update.schema.json,sha256=XEEf-aUXZiqRuM8ccS6nkq7pl3U3-wvj_Mql6OPrZa4,1688
+dwf_cli/schemas/datamodel/create.schema.json,sha256=458XsYV8zIAOqpt6o7-eh8U4YZZgDVdeXbM314Oi3YA,2743
+dwf_cli/schemas/datamodel/excel_confirm.schema.json,sha256=h8sddJcfsfWRbmsFHlEZNVstAux2EgYdoTw5Sb_AoTs,3976
+dwf_cli/schemas/datamodel/external_create.schema.json,sha256=CixPAeOZ5a-j6yPHH7X1CrSrBMHfvuJmAc_MIb2Uk24,2845
+dwf_cli/schemas/datamodel/external_update.schema.json,sha256=vGrO3CdEmJgJhJSr93cuQS8qJhCV1jj1HpuWwJRRWOs,2858
+dwf_cli/schemas/datamodel/object_create.schema.json,sha256=qRD6N99G7gt1JY1DQCCuH1RfS_gVjRQJ8qGdDbuwpvg,742
+dwf_cli/schemas/datamodel/object_update.schema.json,sha256=rI4n0O6095DlCC0XYqfT-n4ruxWCseY0LCHwUN3kb5g,697
+dwf_cli/schemas/datamodel/relation_create.schema.json,sha256=Ia8ym9e5OKBfZpS-2z7Zyyi_GiQTjKxEGJWJCmmswdM,3377
+dwf_cli/schemas/datamodel/relation_update.schema.json,sha256=8bnT4HW4gVBM4Ml24UFmy9iGs6mNRyjrcXKE7AX8SWM,3127
+dwf_cli/schemas/datamodel/update.schema.json,sha256=oeStlqhWkvwfcEAT1awcj6zLOr96qopiK5Et-U_Cx78,2250
+dwf_cli/schemas/funcmodel/app_create.schema.json,sha256=noaxdKi13Xr1U4IJ9OGjKgkxOCEeGPCNWGd2zFyTQFY,9244
+dwf_cli/schemas/funcmodel/app_update.schema.json,sha256=mT6qEaCTGIMjtTakDmhge1__AMwg0WvY-Tbpo-uKX7I,9066
+dwf_cli/schemas/funcmodel/language-package_create.schema.json,sha256=QWGElvixG97-Uov1XieSmsGDoYSg6N_3nUN6aJ-WoG4,1239
+dwf_cli/schemas/funcmodel/operations_create.schema.json,sha256=TFls3SJhxgqsmJ7w3shEZFN7H4OZZPBUkD7vmDr7P5k,8928
+dwf_cli/schemas/funcmodel/operations_update.schema.json,sha256=y6GpekGWntFiL_mHKCsdfOoxL1P-OLc0MMA7nwRx23o,7879
+dwf_platform_cli-0.2.0.dist-info/METADATA,sha256=E2Lm7hUuzbDwH924-LHXPCH3SVVlthufdG_mOJ3uIzI,11143
+dwf_platform_cli-0.2.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+dwf_platform_cli-0.2.0.dist-info/entry_points.txt,sha256=hIgm82JXWtUmS1pFjix3kGI88tBMMWl18iEt6bc8ZFo,83
+dwf_platform_cli-0.2.0.dist-info/licenses/LICENSE,sha256=pdH5MQWzhp8Cq-_PWUCWGwtnUu1a2QtHs3TP5AhSg74,10762
+dwf_platform_cli-0.2.0.dist-info/RECORD,,

dwf_platform_cli-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

dwf_platform_cli-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+dwf-cli = dwf_cli:app
+dwf-platform-mcp = dwf_cli.mcp.server:main