onepage-cli 1.1.0 → 1.2.0

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 (3) hide show
  1. package/README.md +82 -92
  2. package/lib/blog.js +63 -3
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,112 +1,102 @@
1
- # OnePage CLI(onepage-cli)
1
+ # onepage-cli
2
2
 
3
- 在终端用 git 风格指令生成、部署、管理你的 OnePage 静态网页。零依赖,Node 18+ 即可运行。
3
+ OnePage 平台命令行工具(`op` 命令)。在终端部署静态网页、管理博客文章/配置/主题。零依赖,Node 18+。
4
4
 
5
- ## 安装
5
+ - 服务端默认:`https://app.collegehub.cn`(可用环境变量 `OP_SERVER` 覆盖)
6
+ - 认证:Bearer Token,`op login` 获取,本地存于 `~/.onepage-cli.json`
7
+ - 响应格式:JSON `{ok, ...}`,401 表示登录失效需重新 `op login`
6
8
 
7
- ```bash
8
- npm install -g onepage-cli
9
- ```
10
-
11
- 安装后即可使用 `op` 命令(注意:若你同时安装了 1Password CLI,其命令也是 `op`,可通过 `npm exec -p onepage-cli -- op ...` 或全局别名区分)。
12
-
13
- ## 快速开始
14
-
15
- ```bash
16
- op login # 登录(输入邮箱 + 密码)
17
- op init # 在项目目录创建暂存区
18
- op add . # 把代码加入暂存区
19
- op push # 部署上线(交互式输入短链名、预览图、公开、SEO)
20
- ```
21
-
22
- ## 全部命令
9
+ ## 命令
23
10
 
24
11
  ### 账号
25
12
 
26
13
  | 命令 | 说明 |
27
14
  |---|---|
28
- | `op login` | 登录。新邮箱**自动注册**,用户名默认为邮箱 `@` 前面的字符(重名自动加随机后缀) |
15
+ | `op login` | 登录(输入邮箱+密码)。新邮箱自动注册,用户名默认邮箱 @ 前缀 |
29
16
  | `op whoami` | 查看当前登录账号 |
30
- | `op logout` | 退出登录(清除本地凭证) |
17
+ | `op logout` | 退出登录,清除本地凭证 |
31
18
 
32
- ### 部署流程
19
+ ### 静态站点
33
20
 
34
21
  | 命令 | 说明 |
35
22
  |---|---|
36
- | `op init` | 在当前目录创建代码暂存区 `.onepage/`,并生成**站点配置模板 `.onepage/preview.yml`** |
37
- | `op add [路径]` | 把文件/目录加入暂存区,默认当前目录 `.`(自动过滤不支持的类型与 node_modules 等) |
38
- | `op status` | 查看暂存区文件清单与大小 |
39
- | `op push` | 部署暂存区代码上线。**存在 `.onepage/preview.yml` 时直接按其配置部署(免交互)**;不存在时回退为交互式输入:短链名 → 预览图路径或 no → 是否公开 → 是否 SEO。短链名已存在且属于自己时为**覆盖更新** |
23
+ | `op init` | 当前目录创建暂存区 `.onepage/`(stage/ + preview.yml) |
24
+ | `op add [路径]` | 把文件/目录加入暂存区(默认当前目录) |
25
+ | `op status` | 查看暂存区文件 |
26
+ | `op push` | 部署上线。无 `.onepage/preview.yml` 时交互式输入短链名/预览图/公开/SEO;有则按配置免交互部署 |
27
+ | `op list` | 列出本账号所有站点 |
28
+ | `op clone <url>` | 拉取站点代码到本地(支持完整 URL 或短链名) |
29
+ | `op delete <name>` | 删除站点(需确认) |
30
+ | `op open <name>` | 浏览器打开站点 |
40
31
 
41
- ### preview.yml 站点配置(op init 自动生成)
32
+ `preview.yml` 字段:`path_name`(短链名)、`title`、`description`、`preview`(预览图路径,no 跳过)、`is_public`、`seo`。
42
33
 
43
- ```yaml
44
- # OnePage 站点配置 —— 填好后直接执行 op push,无需交互输入
45
- title: '' # 站点名称(留空则使用短链名)
46
- description: '' # 站点介绍
47
- path_name: '' # 短链名:字母/数字/连字符/下划线,<=64 字符(留空则使用目录名)
48
- preview: no # 预览图路径(本地图片文件,无则填 no)
49
- is_public: yes # 是否公开(yes/no)
50
- seo: yes # 是否 SEO 优化(yes/no)
51
- ```
52
-
53
- ### 站点管理
34
+ ### 博客(`op blog <子命令>`)
54
35
 
55
- | 命令 | 说明 |
36
+ | 子命令 | 说明 |
56
37
  |---|---|
57
- | `op list` | 表格列出本账号所有站点(短链名/标题/公开/浏览/点赞/更新时间/URL) |
58
- | `op clone <url>` | 拉取站点代码到 `./<短链名>/`(支持完整 URL 或短链名;公开站点可拉,私有站点仅所有者) |
59
- | `op delete <短链名>` | 删除指定站点(需二次确认 yes/no) |
60
- | `op open <短链名>` | 在浏览器打开站点 |
61
-
62
- ## 支持的文件类型
63
-
64
- `html` `css` `js` `mjs` `jpg` `jpeg` `png` `gif` `svg` `webp` `ico` `json` `txt` `md` `woff` `woff2` `ttf` `eot` `otf` `mp3` `mp4` `webm` `ogg` `wav` `map`
65
-
66
- 暂存区自动跳过:`.onepage`、`node_modules`、`.git` 及隐藏文件。
38
+ | `init` | 创建博客工作区 `.onepage/blog/`(config.yml + posts/ + themes/) |
39
+ | `write <标题>` | 新建带 front-matter 的 Markdown 文章模板 |
40
+ | `push [文件] [--publish]` | 推送文章。`--publish` 直接发布(自动过 AI 审核),否则存草稿 |
41
+ | `pull [slug\|all] [-f]` | 拉取远端文章为 Markdown,`-f` 覆盖本地改动 |
42
+ | `list` | 远端文章列表 |
43
+ | `status` | 本地文章与远端对比 |
44
+ | `delete <slug> [-y]` | 删除文章 |
45
+ | `config [pull\|push]` | 拉取/推送博客配置(标题、介绍、主题及选项) |
46
+ | `categories add\|rename\|delete` | 分类管理 |
47
+ | `themes` | 主题列表 |
48
+ | `theme apply <key> [--opt k=v]` | 应用主题及选项(静态页重建) |
49
+ | `theme push <zip> [--overwrite]` | 上传主题包 |
50
+
51
+ ## 博客文章 front-matter 字段
67
52
 
68
- ## 配置
69
-
70
- 登录凭证保存在 `~/.onepage-cli.json`(权限 600):
71
-
72
- ```json
73
- {
74
- "server": "https://app.collegehub.cn",
75
- "token": "...",
76
- "username": "...",
77
- "email": "..."
78
- }
79
- ```
80
-
81
- 默认服务器为 `https://app.collegehub.cn`;如需指向其他地址,设置环境变量 `OP_SERVER=https://xxx` 后重新 `op login`。
82
-
83
- ## 典型工作流
84
-
85
- ```bash
86
- # 首次
87
- op login
88
- mkdir my-site && cd my-site
89
- # ... 编写 index.html 等文件 ...
90
- op init && op add . && op push
91
- # → 短链名 [my-site]:
92
- # → 预览图路径(no 跳过): no
93
- # → 是否公开(yes/no): yes
94
- # → 是否 SEO 优化(yes/no): yes
95
- # ✓ 部署完成:https://app.collegehub.cn/my-site/
96
-
97
- # 更新:改完代码再 add + push(短链名不变即覆盖更新)
98
- op add . && op push
99
-
100
- # 备份/迁移
101
- op clone https://app.collegehub.cn/my-site/
53
+ ```yaml
54
+ ---
55
+ title: 标题
56
+ slug: url-slug # 留空由服务端按标题生成并保证唯一
57
+ status: draft # draft=草稿 / published=发布
58
+ category: 分类名
59
+ description: 摘要
60
+ cover: # 封面图(1.2.0+)
61
+ # 本地路径(相对 md 文件)→ push 时自动上传
62
+ # http(s) URL → 自动下载转存
63
+ # 留空 → 清除封面
64
+ ---
65
+ 正文支持 Markdown。
102
66
  ```
103
67
 
104
- ## 安全说明
105
-
106
- - 密码仅在登录/注册时通过 HTTPS 提交一次,本地只保存服务端签发的 token
107
- - token 与账号绑定,`op logout` 即可作废本地凭证
108
- - 站点文件由服务端校验扩展名与相对路径(禁止 `..` 越权)
109
-
110
- ## License
111
-
112
- MIT
68
+ - `cover` 仅支持 jpg/jpeg/png/gif/webp,服务端自动压缩为 WebP 存入资源库
69
+ - 本地封面成功上传后,CLI 自动把该字段改写为线上 URL,避免重复上传
70
+ - 封面同时用作文章分享卡片图(og:image)
71
+
72
+ ## 服务端 API(本工具调用)
73
+
74
+ 认证方式:请求头 `Authorization: Bearer <token>`。token 通过 `POST /api/cli/login`(body: `{email, password}`)获取,返回 `{token, username, email}`。
75
+
76
+ | 方法 | 路径 | 说明 |
77
+ |---|---|---|
78
+ | POST | `/api/cli/deploy` | 部署站点(multipart:文件 + path_name/title/description/preview/is_public/seo) |
79
+ | GET | `/api/cli/sites` | 站点列表 |
80
+ | DELETE | `/api/cli/site/<name>` | 删除站点 |
81
+ | GET | `/api/cli/download/<name>` | 打包下载站点代码 |
82
+ | GET/POST | `/api/cli/blog/config` | 博客配置读取/保存(site_title/description/theme/options) |
83
+ | GET | `/api/cli/blog/posts` | 文章列表(含 cover 字段) |
84
+ | POST | `/api/cli/blog/posts` | 创建/更新文章。body: `{slug?, title?, markdown, description?, category?, status?, publish?, cover_asset_id?, cover_remove?}` |
85
+ | GET | `/api/cli/blog/post/<slug>` | 文章详情(含 markdown 与 cover) |
86
+ | DELETE | `/api/cli/blog/post/<slug>` | 删除文章 |
87
+ | POST | `/api/cli/blog/post/<slug>/publish` | 发布文章 |
88
+ | POST | `/api/cli/blog/assets` | 上传图片资源(multipart `file`),返回 `{asset_id, url}`,自动压缩 WebP |
89
+ | GET/POST | `/api/cli/blog/categories` | 分类查询/管理(action: add/rename/delete) |
90
+ | GET | `/api/cli/blog/themes` | 主题列表 |
91
+ | POST | `/api/cli/blog/theme/apply` | 应用主题(body: `{theme, options}`) |
92
+ | POST | `/api/cli/blog/theme/import` | 导入主题包(multipart zip) |
93
+
94
+ ## 注意事项
95
+
96
+ 1. 需要 Node 18+(使用原生 fetch / FormData / Blob,无第三方依赖)。
97
+ 2. 命令名 `op` 与 1Password CLI 重名,冲突时用 `npm exec -p onepage-cli -- op ...` 或设置别名。
98
+ 3. 暂存区/博客工作区均在项目目录的 `.onepage/` 下,可加入 .gitignore。
99
+ 4. `--publish` 发布会触发 AI 内容审核与静态页重建,属异步操作。
100
+ 5. 文章 slug 服务端保证唯一;重复 push 同一 slug 为更新。
101
+ 6. 本地凭证文件 `~/.onepage-cli.json` 权限 600,含 Bearer token,勿泄露。
102
+ 7. 所有写操作(发布/删除/配置/主题)都会即时同步线上并对已发布页面生效。
package/lib/blog.js CHANGED
@@ -2,6 +2,7 @@
2
2
  // op blog —— 博客模块命令组(文章 Markdown 双向同步 / 配置 / 分类 / 主题)
3
3
  const fs = require('fs');
4
4
  const path = require('path');
5
+ const os = require('os');
5
6
  const { api } = require('./api');
6
7
  const { ok, err, info, warn, table } = require('./util');
7
8
 
@@ -158,7 +159,7 @@ function cmdWrite(args) {
158
159
  while (fs.existsSync(file)) file = path.join(POSTS_DIR, slug + '-' + n++ + '.md');
159
160
  fs.writeFileSync(file, buildFrontMatter({
160
161
  title, slug: path.basename(file, '.md'),
161
- status: 'draft', category: '', description: '',
162
+ status: 'draft', category: '', description: '', cover: '',
162
163
  }, '正文从这里开始…\n'));
163
164
  ok('已创建 ' + file);
164
165
  console.log(' 写完后执行 op blog push ' + path.basename(file) + ' --publish 发布');
@@ -188,6 +189,50 @@ async function cmdStatus(cfg) {
188
189
  info('执行 op blog push 上传变更;--publish 同时发布');
189
190
  }
190
191
 
192
+
193
+ /* ---------- 封面(cover)---------- */
194
+ function mimeFromName(name) {
195
+ const e = path.extname(name).toLowerCase();
196
+ return { '.jpg': 'image/jpeg', '.jpeg': 'image/jpeg', '.png': 'image/png',
197
+ '.gif': 'image/gif', '.webp': 'image/webp' }[e] || '';
198
+ }
199
+
200
+ async function uploadCoverFile(cfg, filePath) {
201
+ const mime = mimeFromName(filePath);
202
+ if (!mime) throw new Error('封面仅支持 jpg/jpeg/png/gif/webp:' + filePath);
203
+ const form = new FormData();
204
+ form.append('file', new Blob([fs.readFileSync(filePath)], { type: mime }), path.basename(filePath));
205
+ const res = await fetch(cfg.server + '/api/cli/blog/assets', {
206
+ method: 'POST', headers: { Authorization: 'Bearer ' + cfg.token }, body: form,
207
+ });
208
+ const data = await res.json().catch(() => ({}));
209
+ if (res.status === 401) die('登录已失效,请重新执行 op login');
210
+ if (!data.ok) throw new Error(data.error || '封面上传失败');
211
+ return data;
212
+ }
213
+
214
+ // 解析 front-matter 的 cover:空→清除;http(s) URL→下载后上传;否则视为本地路径
215
+ async function resolveCover(cfg, coverVal, mdFile) {
216
+ const cv = String(coverVal || '').trim();
217
+ if (!cv) return { cover_remove: true };
218
+ if (/^https?:\/\//i.test(cv)) {
219
+ const res = await fetch(cv);
220
+ if (!res.ok) throw new Error('封面 URL 无法下载:' + cv);
221
+ const buf = Buffer.from(await res.arrayBuffer());
222
+ const name = path.basename(new URL(cv).pathname) || 'cover.jpg';
223
+ const tmp = path.join(os.tmpdir(), 'op-cover-' + Date.now() + '-' + name.replace(/[^\w.-]/g, '_'));
224
+ fs.writeFileSync(tmp, buf);
225
+ try {
226
+ const up = await uploadCoverFile(cfg, tmp);
227
+ return { cover_asset_id: up.asset_id, cover_url_final: up.url };
228
+ } finally { try { fs.unlinkSync(tmp); } catch (e) {} }
229
+ }
230
+ const local = path.isAbsolute(cv) ? cv : path.join(path.dirname(path.resolve(mdFile)), cv);
231
+ if (!fs.existsSync(local)) throw new Error('封面文件不存在:' + cv);
232
+ const up = await uploadCoverFile(cfg, local);
233
+ return { cover_asset_id: up.asset_id, cover_url_final: up.url };
234
+ }
235
+
191
236
  /* ---------- push ---------- */
192
237
  async function cmdPush(args, cfg) {
193
238
  const publishFlag = args.includes('--publish');
@@ -206,6 +251,12 @@ async function cmdPush(args, cfg) {
206
251
  const { meta, body } = parseFrontMatter(fs.readFileSync(f, 'utf8'));
207
252
  if (!body.trim()) { warn('跳过空文件:' + f); continue; }
208
253
  const publish = publishFlag || meta.status === 'published';
254
+ // 封面:front-matter 的 cover 字段(留空=清除封面;本地路径或 http URL)
255
+ let coverInfo = null;
256
+ if (meta.cover !== undefined) {
257
+ try { coverInfo = await resolveCover(cfg, meta.cover, f); }
258
+ catch (e) { warn('封面处理失败:' + e.message + ' ← ' + f); }
259
+ }
209
260
  const r = await authed(cfg, 'POST', '/api/cli/blog/posts', {
210
261
  slug: meta.slug || path.basename(f, '.md'),
211
262
  title: meta.title || '',
@@ -213,11 +264,19 @@ async function cmdPush(args, cfg) {
213
264
  description: meta.description || '',
214
265
  category: meta.category || '',
215
266
  publish,
267
+ ...(coverInfo || {}),
216
268
  });
217
269
  if (!r.data.ok) { warn((r.data.error || '推送失败') + ' ← ' + f); continue; }
218
270
  if (publish) published++; else saved++;
219
271
  console.log((publish ? ' ✓ 已发布' : ' ✓ 已保存草稿') + ' ' + r.data.slug +
220
- (r.data.created ? '(新建)' : '(更新)'));
272
+ (r.data.created ? '(新建)' : '(更新)') +
273
+ (r.data.cover ? '(封面已设置)' : (coverInfo && coverInfo.cover_remove ? '(封面已清除)' : '')));
274
+ // 本地文件路径上传成功后,把 cover 改写为线上 URL,避免下次 push 重复上传
275
+ if (r.data.ok && coverInfo && coverInfo.cover_url_final && !/^https?:/i.test(String(meta.cover || ''))) {
276
+ const abs = new URL(coverInfo.cover_url_final, cfg.server + '/').href;
277
+ const updated = fs.readFileSync(f, 'utf8').replace(/^(cover:\s*).*$/m, (m0, p1) => p1 + abs);
278
+ fs.writeFileSync(f, updated);
279
+ }
221
280
  }
222
281
  if (published) info(published + ' 篇已发布,将自动进行 AI 内容审核');
223
282
  if (saved) info(saved + ' 篇存为草稿,发布执行 op blog push <文件> --publish 或到网页后台');
@@ -249,6 +308,7 @@ async function cmdPull(args, cfg) {
249
308
  const content = buildFrontMatter({
250
309
  title: p.title, slug: p.slug, status: p.status,
251
310
  category: p.category || '', description: p.description || '',
311
+ cover: p.cover ? new URL(p.cover, cfg.server + '/').href : '',
252
312
  }, md);
253
313
  if (fs.existsSync(file) && !force && fs.readFileSync(file, 'utf8') !== content) {
254
314
  warn('本地有改动,跳过(用 -f 覆盖):' + p.slug + '.md');
@@ -345,7 +405,7 @@ function cmdHelp() {
345
405
  ' init 创建博客工作区 .onepage/blog/(config.yml + posts/ + themes/)',
346
406
  ' write <标题> 新建带 front-matter 的 Markdown 文章模板',
347
407
  ' status 本地文章与远端对比',
348
- ' push [文件] [--publish] 推送文章(--publish 直接发布,自动过 AI 审核)',
408
+ ' push [文件] [--publish] 推送文章(--publish 直接发布,自动过 AI 审核;front-matter 支持 cover 封面)',
349
409
  ' pull [slug|all] [-f] 拉取远端文章为 Markdown(-f 覆盖本地改动)',
350
410
  ' list 远端文章列表',
351
411
  ' delete <slug> [-y] 删除文章',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "onepage-cli",
3
- "version": "1.1.0",
3
+ "version": "1.2.0",
4
4
  "description": "OnePage 命令行工具:在终端部署管理静态网页与博客(op 静态站指令 + op blog 文章/配置/主题指令)",
5
5
  "bin": {
6
6
  "op": "bin/op.js"