@adep/cli 0.0.5 → 0.0.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.
- package/README.md +45 -50
- package/dist/index.js +1518 -1706
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# adep — AgentDeploy CLI
|
|
2
2
|
|
|
3
|
-
> 面向终端开发者的 AgentDeploy 命令行工具:**登录 / 初始化 / 本地调试 / 部署 / 数据库维护 / 云存储 / 静态托管 /
|
|
3
|
+
> 面向终端开发者的 AgentDeploy 命令行工具:**登录 / 初始化 / 本地调试 / 部署 / 数据库维护 / 云存储 / 静态托管 / 全栈工程(functions/ + web/ 前端)** 一站式闭环。
|
|
4
4
|
|
|
5
5
|
`adep` 让你在一个项目目录里完成从**脚手架 → 本地调试 → 部署上线 → 数据与资源运维**的完整流程。它复用平台运行时内核(`@adep/runtime`),本地与线上的执行语义一致,离线、不装 Docker 也能开发。
|
|
6
6
|
|
|
@@ -46,8 +46,6 @@
|
|
|
46
46
|
|
|
47
47
|
- [`adep export`](#adep-export)
|
|
48
48
|
|
|
49
|
-
- [`adep widget`](#adep-widget)
|
|
50
|
-
|
|
51
49
|
4. [配置](#配置)
|
|
52
50
|
|
|
53
51
|
- [环境变量](#环境变量)
|
|
@@ -114,32 +112,51 @@ adep --json whoami
|
|
|
114
112
|
|
|
115
113
|
### `adep init`
|
|
116
114
|
|
|
117
|
-
|
|
115
|
+
初始化项目(脚手架)。**默认 `fullstack` 模板**:生成与 Web IDE 项目**同一结构**的全栈骨架
|
|
116
|
+
(`functions/` 云函数 + `web/` 标准 Vite 前端工程 + `database/schema.sql`):
|
|
118
117
|
|
|
119
|
-
| 模板
|
|
120
|
-
|
|
|
121
|
-
| `
|
|
122
|
-
| `function`
|
|
118
|
+
| 模板 | 说明 |
|
|
119
|
+
| ----------- | ------------------------------------------------------------------------------ |
|
|
120
|
+
| `fullstack` | 全栈骨架:`functions/` + `web/`(Vite + Vue 3)+ `database/schema.sql`(默认) |
|
|
121
|
+
| `function` | 仅云函数:单个示例函数 `functions/hello.ts` |
|
|
122
|
+
| `empty` | 仅项目骨架(`adep.config.ts` + 类型提示入口,不生成示例产物) |
|
|
123
123
|
|
|
124
124
|
```bash
|
|
125
|
-
adep init my-app
|
|
126
|
-
adep init my-app -t
|
|
127
|
-
adep init
|
|
125
|
+
adep init my-app # 默认 fullstack 模板(与 Web IDE 项目同构)
|
|
126
|
+
adep init my-app -t function # 仅云函数
|
|
127
|
+
adep init my-app -t empty # 空模板
|
|
128
|
+
adep init --list # 从平台 GET /api/v1/templates 列出可用模板
|
|
128
129
|
adep init --list -s https://platform.example.com
|
|
129
130
|
```
|
|
130
131
|
|
|
131
|
-
产物结构(`
|
|
132
|
+
产物结构(`fullstack` 模板):
|
|
132
133
|
|
|
133
134
|
```
|
|
134
135
|
my-app/
|
|
135
136
|
├── adep.config.ts # 项目标识(dev / deploy 按此识别)
|
|
137
|
+
├── tsconfig.json # 云函数 TypeScript 编辑器配置(strict + noEmit)
|
|
138
|
+
├── adep.d.ts # 云函数上下文环境类型声明(ctx: AdepContext 补全)
|
|
136
139
|
├── functions/
|
|
137
140
|
│ ├── hello.ts # 示例函数(deploy 后经 /hello 触发)
|
|
138
141
|
│ └── README.md
|
|
142
|
+
├── web/ # 前端工程(标准 Vite + Vue 3,与 Web IDE 项目同构)
|
|
143
|
+
│ ├── index.html
|
|
144
|
+
│ ├── package.json
|
|
145
|
+
│ ├── vite.config.ts
|
|
146
|
+
│ └── src/{main.ts, App.vue}
|
|
147
|
+
├── database/
|
|
148
|
+
│ └── schema.sql # 数据库结构(占位;表由平台控制台 / adep db 管理)
|
|
139
149
|
├── README.md
|
|
140
150
|
└── .gitignore # 已忽略 node_modules/ data/ .adep/
|
|
141
151
|
```
|
|
142
152
|
|
|
153
|
+
**web/ 前端工程**:与 Web IDE 内创建的项目完全同构(同一份模板真相源),可无缝在两端切换开发;
|
|
154
|
+
本地跑前端:`cd web && npm install && npm run dev`,部署由 `adep deploy` 统一构建发布。
|
|
155
|
+
|
|
156
|
+
**类型提示**:`adep init` 产出的项目自带 `tsconfig.json` 与 `adep.d.ts`,用 VSCode 打开即可在
|
|
157
|
+
`functions/` 下获得 `AdepContext` / `ctx.cloud.*` 补全,无需本机安装 `@adep/types`。
|
|
158
|
+
函数签名写 `export default async (ctx: AdepContext) => {...}` 即可。
|
|
159
|
+
|
|
143
160
|
> 目录已存在时会拒绝覆盖(fail loud),不会静默改写你的代码。
|
|
144
161
|
|
|
145
162
|
### `adep dev`
|
|
@@ -182,6 +199,7 @@ adep serve --static web # 指定静态托管目录(缺省 public/)
|
|
|
182
199
|
```
|
|
183
200
|
|
|
184
201
|
- 缺省值优先级为「命令行旗标 > 环境变量(`PORT` / `HOST` / `ADEP_SERVE_STATIC_DIR`)> 内置缺省」,容器编排注入的 `PORT` / `HOST` 不会被命令行缺省盖掉。
|
|
202
|
+
|
|
185
203
|
- 绑定非回环地址时给出对外暴露警告(它不带生产级加固)。
|
|
186
204
|
|
|
187
205
|
### `adep deploy`
|
|
@@ -219,7 +237,9 @@ adep projects info game-arcade # id \t slug \t name \t url
|
|
|
219
237
|
```
|
|
220
238
|
|
|
221
239
|
- `--name` 缺省取 slug:一行命令即可建项目。
|
|
240
|
+
|
|
222
241
|
- 目标 slug 已占用 → 平台返回 `PROJECT_SLUG_TAKEN`,CLI 原样透传并退出码 1。
|
|
242
|
+
|
|
223
243
|
- 未登录 / 会话失效 → 打印错误后附带 `提示:先执行 adep login`。
|
|
224
244
|
|
|
225
245
|
### `adep functions`
|
|
@@ -234,6 +254,7 @@ adep functions logs hello -p my-app --tail 50
|
|
|
234
254
|
```
|
|
235
255
|
|
|
236
256
|
- `deploy` 与 `adep deploy` 共用同一执行体,输出逐字一致(两个入口各写一遍迟早只有一处有汇总行)。
|
|
257
|
+
|
|
237
258
|
- 日志缓冲在平台进程内(环形),**未执行过的函数为空**——命令会如实说明而非报错。
|
|
238
259
|
|
|
239
260
|
### `adep mcp`
|
|
@@ -249,8 +270,11 @@ adep mcp list # 打印端点地址 + 已
|
|
|
249
270
|
```
|
|
250
271
|
|
|
251
272
|
- `--function` 是**函数名**,`--name` 是可选的**注册 Tool 名**(缺省取函数名);目标项目缺省取 `adep.config.ts` 的 `name`,也可用 `-p <slug>` 指定。
|
|
273
|
+
|
|
252
274
|
- 服务端错误原样透出:函数入参无法映射为 JSON Schema 时返回 `MCP_SCHEMA_UNSERIALIZABLE` 并以退出码 1 结束(CLI 不改写、不兜底,原因由服务端指出)。
|
|
253
|
-
|
|
275
|
+
|
|
276
|
+
- `mcp list` 读的是**项目** **`/mcp`** **端点的** **`tools/list`**(与外部 Agent 同一条路径):项目 MCP 鉴权模式为 `public` 时可直接读取;为 `api-key` 时未带 Key 会返回 `MCP_UNAUTHORIZED`。
|
|
277
|
+
|
|
254
278
|
- `unpublish` 默认按函数名移除;若曾以别名发布,需加 `--name <tool>` 指向该别名。取消一个不存在的工具会如实说明、不报成功也不报错。
|
|
255
279
|
|
|
256
280
|
### `adep doctor`
|
|
@@ -263,7 +287,9 @@ adep doctor --json # { server, credentials, network, serverHealth, offlineCom
|
|
|
263
287
|
```
|
|
264
288
|
|
|
265
289
|
- 已登录时体检的是**凭据里记录的那个平台**(`login --server` 可指到任意环境),未登录才回退 `ADEP_SERVER` 缺省。
|
|
290
|
+
|
|
266
291
|
- 平台可达性 = 对 `GET /api/v1/health` 的一次真实探测;拿到任何 HTTP 应答都算可达。
|
|
292
|
+
|
|
267
293
|
- 凭据文件权限宽于 `0600` 会给告警;命令本身**不因体检结论失败**(它是诊断,不是门)。
|
|
268
294
|
|
|
269
295
|
### `adep db`
|
|
@@ -335,41 +361,8 @@ adep export --out ./dist-export # 指定输出目录(缺省 ./exports)
|
|
|
335
361
|
```
|
|
336
362
|
|
|
337
363
|
- `--with-data` 附带行数据,`--with-source` 附带函数源码(平台缺省已含,显式给出不改变默认)。
|
|
338
|
-
- `--json` 输出单个结果信封;导出失败(长任务未产出 / 自检不过)以退出码 1 + `EXPORT_FAILED` 结束,不静默给半截产物。
|
|
339
364
|
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
微前端组件(widget)的子命令组:脚手架 / 本地沙箱 / 发布。
|
|
343
|
-
|
|
344
|
-
#### `adep widget init`
|
|
345
|
-
|
|
346
|
-
```bash
|
|
347
|
-
adep widget init my-widget # 默认 vue3-ts 模板
|
|
348
|
-
adep widget init my-widget -t react-ts # 或 react-ts
|
|
349
|
-
```
|
|
350
|
-
|
|
351
|
-
widget 名称需以小写字母开头,仅含小写字母 / 数字 / 连字符。
|
|
352
|
-
|
|
353
|
-
#### `adep widget dev`
|
|
354
|
-
|
|
355
|
-
本地宿主沙箱:主题变量 + mock props + token 注入 + 热更新,默认 `http://127.0.0.1:8788`。
|
|
356
|
-
|
|
357
|
-
```bash
|
|
358
|
-
adep widget dev # 默认端口 8788
|
|
359
|
-
adep widget dev -p 9000
|
|
360
|
-
# 在浏览器打开 ?token=<...> 可注入鉴权 token
|
|
361
|
-
```
|
|
362
|
-
|
|
363
|
-
#### `adep widget publish`
|
|
364
|
-
|
|
365
|
-
按框架构建 → 上传平台静态资源 → 版本化输出 URL:
|
|
366
|
-
|
|
367
|
-
```bash
|
|
368
|
-
adep widget publish -p my-app
|
|
369
|
-
# → my-widget v0.1.0 https://my-app.platform.example.com/widgets/my-widget/0.1.0/index.js
|
|
370
|
-
```
|
|
371
|
-
|
|
372
|
-
版本取自 widget `package.json` 的 `version`(缺省 `0.1.0`);产物是单个 ESM 文件。
|
|
365
|
+
- `--json` 输出单个结果信封;导出失败(长任务未产出 / 自检不过)以退出码 1 + `EXPORT_FAILED` 结束,不静默给半截产物。
|
|
373
366
|
|
|
374
367
|
---
|
|
375
368
|
|
|
@@ -397,7 +390,7 @@ export ADEP_HOME=~/.adep
|
|
|
397
390
|
// adep 项目配置:CLI(dev / deploy)按 default export 读取(name / functionsDir)。
|
|
398
391
|
export default {
|
|
399
392
|
name: 'my-app', // 项目名(deploy 的默认 slug)
|
|
400
|
-
template: '
|
|
393
|
+
template: 'fullstack', // 模板:empty | function | fullstack
|
|
401
394
|
}
|
|
402
395
|
```
|
|
403
396
|
|
|
@@ -449,8 +442,8 @@ adep --json deploy -p my-app
|
|
|
449
442
|
**Q:`adep deploy`** **显示** **`no changes`?**
|
|
450
443
|
这是幂等设计:本地函数内容与已发布版本一致时复用当前版本,不产生新版本。想强制更新需修改函数内容。
|
|
451
444
|
|
|
452
|
-
**Q
|
|
453
|
-
`init` 项目名:小写字母开头,仅含小写字母 / 数字 / 连字符(≤ 63
|
|
445
|
+
**Q:项目名的命名规则?**
|
|
446
|
+
`init` 项目名:小写字母开头,仅含小写字母 / 数字 / 连字符(≤ 63 字符)。
|
|
454
447
|
|
|
455
448
|
**Q:`adep db exec`** **的** **`--confirm-table`** **是做什么的?**
|
|
456
449
|
写 / 破坏性语句(DELETE / DROP / ALTER…)服务端要求二次确认目标表名,`--confirm-table users` 即输入目标表名以放行;只读查询无需该参数。
|
|
@@ -469,3 +462,5 @@ adep --json deploy -p my-app
|
|
|
469
462
|
## 相关
|
|
470
463
|
|
|
471
464
|
- `@adep/runtime` —— 平台运行时内核(执行器 + 本地模拟运行时 + 能力装配),`adep dev` 复用其保证本地/线上语义一致。
|
|
465
|
+
|
|
466
|
+
<br />
|