-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcli.rs
More file actions
796 lines (742 loc) · 28.3 KB
/
Copy pathcli.rs
File metadata and controls
796 lines (742 loc) · 28.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
//! clap 定义:全局参数(--profile / --json / --insecure)与子命令枚举。
//! 与 main 解耦——参数结构即命令面的单一事实来源。
//! 顶层 help 用自定义模板渲染「按协议域分组」的命令目录(agent 一屏看全貌),
//! GROUPED_CATALOG 与实际子命令由单测强制同步(缺一个即测试失败)。
use clap::{Parser, Subcommand};
/// 顶层帮助的分组命令目录 + 示例/提示(渲染进 --help 的 after-help 段)
const GROUPED_CATALOG: &str = "\
命令总览(按协议域分组;详细参数看 `bcode <命令> --help`)
身份与接入
register <name> 注册身份(key 只此一次返回并落盘,不回显)
whoami 本地概览:profile/凭证/项目指向/会话缓存(不打网络)
status 在线校验:身份/准入/会话有效性 + 可见任务采样
profiles 本地 profile 清单(server 绑定 + active 标记)
use <p> 切换激活 profile(多实例切换入口)
join <code> 凭接入码加入项目(写 .bc/project)
projects 已加入项目清单(标注当前目录指向)
工作会话
start [--project] 建立会话 + 展示开工包(约定/我的任务/待审)
context 开工包约定(conventions)原样输出——AI 建立项目认知的入口
任务工作流
tasks 免参列表(未完成三态;优先级升序;--status/--keyword/--priority/--sort)
task <id> 单任务详情:描述/artifacts/执行日志/评论
create 建任务(--title/--description/--file JSON 绕开编码坑;实验性)
update <id> 改字段(--title/--type/--priority/--due;状态流转走 claim/complete)
claim <id> 原子认领(租约 2h,周期 log 保活)
task-release <id> 释放任务(认领人放回任务池,不必等 2h 租约)
watch <id> 关注任务(订阅动态通知,幂等)
unwatch <id> 取消关注任务
block <id> 上报阻塞(豁免租约回收;等 CI/等人时用,--reason 必填)
unblock <id> 解除阻塞(恢复执行)
reopen <id> 重开终态任务(--reason 必填;平台限人类用户)
complete <id> 完成 → review(--artifacts-file/--note;上限 1 MiB)
log <id> <msg> 过程留痕(执行日志;刷新租约;failed=记录失败,非放弃)
通信
comment <id> <text> 发表评论(支持 @提及)
comments <id> 评论流(--follow 增量轮询,一行一事件)
notify 通知(--unread / --read <id> / --read-all / --watch SSE 实时流)
上下文消费
docs [path] 文档中枢(读正文 / --list / --search;--write-file 写入;--move-from/--move-to 移动)
memory <key> 项目记忆(--set/--file 写;--global --propose 全局提案)
memories 记忆列表(--prefix 前缀过滤)
search <kw> 全局搜索(已获读权的项目范围)
QA 库与反馈
qa [kw] 问答检索(--add 沉淀 / --hit 计数 / --archive 归档)
feedback 跨项目反馈(--send 投递 / --sent 已发追踪 / 缺省收件箱 / convert / dismiss)
讨论区(想法 → 议题线程 → 转任务)
discuss [id] 讨论列表 / 详情(含回复);--new --title 发起
discuss --reply 回复(--reply 文本 / --reply-file 文件;需 discuss 能力位)
discuss --convert 转任务(血缘互链);--archive 归档切换
项目发布(Releases,团队内分发)
release 发布列表(--channel 过滤)
release --create <v> --file f ... 创建并上传(--notes-file 说明)
release --download <v> [-o dir] 下载(--file 按名过滤)
release --delete <v> 删除(级联清文件)
工作日志(项目演化记录)
worklog 倒序列表(id/日期/作者/来源/首行)
worklog --show <id> 单条完整内容;--write --file 记录(需能力位)
worklog --draft --from --to 从已完成任务/发布生成草稿(stdout,不落库)
专题(长期任务阶段化)
topic --create 创建专题(--title/--goal/--acceptance;默认自任执行)
topic --phases <tid> --file f PRD 拆解批量导入阶段(整体替换)
topic --detail <id> 详情(阶段清单 + 最近交接)
topic work 推进阶段(--work <tid> --phase <pid> --next 自动下一态)
topic log 专题留痕(--log <id> --detail-text;handoff=交接摘要)
topic convert 阶段转日常任务(--convert <tid> --phase <pid>)
测试执行(配合平台执行记录)
test --run -- <cmd> 包裹执行测试命令(--junit <path> 顺手上报;退出码透传)
test --upload <file> 离线补传(junit XML / byte-code-pytest --bcode-dump JSON,自动识别)
test --cases --pull 平台用例拉取为 YAML(--dir tests/cases;AI 可读用例写代码)
test --cases --push YAML 推送回平台(按 id/externalKey upsert;--dry-run 试运行)
配置与工具
init [url] 引导写配置(TTY 交互;纯 host 自动补 /api)
open <task|board> 生成 Web 深链并尝试打开浏览器
completion <shell> shell 补全脚本(stdout)
man man 手册(roff,stdout)
skill skill 管理:缺省写正本到数据根;--path 宿主目录建链接(单副本)
示例
bcode register my-agent # 一次性拿 bc_ key
bcode join <接入码> # owner 在 Web 项目设置页生成
bcode start # 会话 + 开工包
bcode tasks && bcode claim 42 && bcode complete 42 --artifacts-file out.md
bcode notify --watch # SSE 实时通知
提示
--json 全部输出单行 JSON(agent/脚本消费的稳定契约)
--profile / BC_AGENT 切换身份(协议 4A:身份与项目指向正交)
退出码 0 成功 · 2 用法/环境错 · 3 认证失效 · 4 权限拒 · 5 网络错 · 6 业务拒
BC_HOME 覆盖数据根目录 ~/.cicbyte/apps/byte-code-cli";
#[derive(Parser)]
#[command(
name = "bcode",
// 构建期注入(build.rs):BCODE_VERSION > git describe > Cargo.toml,
// 保证发布二进制与 tag 版本一致
version = env!("BCODE_BUILD_VERSION"),
about = "ByteCode CLI — agent 与平台之间的本地桥",
help_template = "{about}\n\n{usage-heading} {usage}\n\n{options}{after-help}",
after_help = GROUPED_CATALOG
)]
pub struct Cli {
/// 身份 profile(默认取 BC_AGENT 或 default;协议 4A:身份与项目指向正交)
#[arg(long, global = true)]
pub profile: Option<String>,
/// 全部输出改为单行 JSON(供 AI/脚本消费的稳定契约)
#[arg(long, global = true)]
pub json: bool,
/// 跳过 TLS 证书校验(自签/调试专用;优先于 config.toml 的 insecure)
#[arg(long, global = true)]
pub insecure: bool,
/// 临时服务器地址(当次生效:覆盖 profile/项目指针之外的地址配置;
/// mysql -h 的 CLI 等价物。不含 key——凭证仍按 profile 取)
#[arg(long, global = true)]
pub server: Option<String>,
#[command(subcommand)]
pub command: Command,
}
#[derive(Subcommand)]
pub enum Command {
/// 注册身份(key 只此一次返回并落盘,不回显;覆盖已有凭证需 --force)
Register(RegArgs),
/// 本地概览:当前 profile / 凭证 / 项目指向 / 会话缓存(不打网络)
Whoami,
/// 在线校验:身份/准入/会话有效性 + 可见任务采样
Status,
/// 本地 profile 清单
Profiles,
/// 切换激活 profile(多实例:改 active 并按其绑定连接)
Use { profile: String },
/// 凭接入码加入项目,成功写 <repo>/.bc/project
Join(JoinArgs),
/// 列出已加入的项目(标注当前目录指向)
Projects,
/// 建立工作会话并展示开工包(约定 / 我的任务 / 待审)
Start(StartArgs),
/// 输出开工包约定(conventions,AI 建立项目认知的入口)
Context,
/// 任务列表(会话免参;缺省=未完成三态;默认优先级升序)
Tasks(TasksArgs),
/// 单任务详情:描述 / artifacts / 执行日志 / 评论
Task(TaskIdArg),
/// 建任务(实验性:owner/编排侧补齐;--file 读 UTF-8 JSON 绕开 shell 编码坑)
Create(CreateArgs),
/// 更新任务字段(agent 可改:标题/描述/类型/优先级/截止;状态流转走 claim/complete)
Update(UpdateArgs),
/// 认领任务(原子;被抢则失败)。租约 2h,周期 log 保活;认错用 release 即时放回
Claim(TaskIdArg),
/// 释放任务(认领人放回任务池,即刻可被他人认领;不必等 2h 租约)
TaskRelease(TaskIdArg),
/// 上报阻塞(in_progress→blocked,豁免租约回收;等 CI/等人/等环境时用)
Block(BlockArgs),
/// 解除阻塞(blocked→in_progress,恢复执行)
Unblock(TaskIdArg),
/// 关注任务(订阅动态通知:评论/认领/完成/阻塞/解除/重开/审核;幂等)
Watch(TaskIdArg),
/// 取消关注任务(停止订阅动态通知)
Unwatch(TaskIdArg),
/// 重开终态任务(done/closed → open;--reason 必填留痕。平台限人类用户,agent 身份会被拒)
Reopen(ReopenArgs),
/// 完成任务进 review(artifacts 为 markdown 产出,上限 1 MiB)
Complete(CompleteArgs),
/// 过程留痕(执行日志;同时刷新认领租约)。--status failed=记录一次失败事件,非放弃
Log(LogArgs),
/// 发表任务评论(支持 @提及)
Comment(CommentArgs),
/// 查看任务评论流;--follow 增量轮询(一行一事件)
Comments(CommentsArgs),
/// 通知列表;--read/--read-all 标已读;--watch SSE 实时流(一行一事件)
Notify(NotifyArgs),
/// 文档中枢:缺省目录树;给 path 读正文;--write-file 写入(设计沉淀进平台)
Docs(DocsArgs),
/// 项目记忆:缺省读取;--set/--file 写入;--delete 删除
Memory(MemoryArgs),
/// 项目记忆列表
Memories(MemoriesArgs),
/// 全局搜索(已获读权的项目范围)
Search(SearchArgs),
/// 引导式写 config.toml(server_url;缺省交互询问)
Init(InitArgs),
/// 生成 Web 深链并尝试打开浏览器
Open(OpenArgs),
/// 生成 shell 补全脚本到 stdout(source 或装入补全目录)
Completion(CompletionArgs),
/// 生成 man 手册(roff)到 stdout
Man,
/// 安装/升级内嵌的 bcode skill(升级 CLI 后一条命令刷新本地发现目录)
Skill(SkillArgs),
/// QA 库:缺省搜索;add 沉淀 / hit 命中计数 / archive 归档
Qa(QaArgs),
/// 跨项目反馈:send 投递 / list 收件箱 / convert 转任务 / dismiss 忽略
Feedback(FeedbackArgs),
/// 专题:list 详情 / work 推进阶段 / log 留痕 / convert 阶段转任务 / finish 终验收
Topic(TopicArgs),
/// 讨论区:列表/详情/发起/回复/转任务(想法的任务前置形态)
Discuss(DiscussArgs),
/// 项目发布:create/upload/list/download/delete(本地打包推平台分发)
Release(ReleaseArgs),
/// 工作日志:list/show/write/draft(项目演化记录;写入需 worklog 能力位)
Worklog(WorklogArgs),
/// 测试执行:--run 包裹执行并上报 / --upload junit·dump 补传 / --cases pull·push 用例同步
Test(TestArgs),
}
// 子命令参数体(main 以 Command::X(Args { .. }) 模式匹配)
#[derive(clap::Args)]
pub struct RegArgs {
/// 全局唯一名称,如 codex-cli;重名被拒时可加后缀重试
pub name: String,
/// 覆盖 profile 已有凭证(防护默认拒绝——多实例下静默覆盖会丢另一实例认证)
#[arg(long)]
pub force: bool,
/// 逗号分隔能力声明(可选)
#[arg(long)]
pub capabilities: Option<String>,
}
#[derive(clap::Args)]
pub struct JoinArgs {
/// owner 在 Web 项目设置页生成的一次性接入码(bcg_ 前缀,展示即焚)
pub code: String,
}
#[derive(clap::Args)]
pub struct StartArgs {
/// 项目 id 或名称;缺省取 .bc/project 指向
#[arg(long)]
pub project: Option<String>,
}
#[derive(clap::Args)]
pub struct TasksArgs {
/// open / in_progress / review / all
#[arg(long)]
pub status: Option<String>,
/// 标题关键词过滤
#[arg(long)]
pub keyword: Option<String>,
/// 按优先级过滤(1-5,1 最高)
#[arg(long)]
pub priority: Option<i64>,
/// 排序:priority(默认,升序 P1 在前)/ id(平台原始顺序)
#[arg(long, default_value = "priority")]
pub sort: String,
/// 跨项目聚合「我的任务」(GET /my-tasks,不依赖当前目录指向)
#[arg(long)]
pub mine: bool,
}
#[derive(clap::Args)]
pub struct CreateArgs {
/// 任务标题(--file 已提供时可用此项覆盖)
#[arg(long)]
pub title: Option<String>,
/// 任务描述
#[arg(long)]
pub description: Option<String>,
/// 完整请求体 JSON 文件(UTF-8;字段即平台 TaskCreateReq,Windows 下推荐)
#[arg(long)]
pub file: Option<String>,
/// 类型(务必按语义传:bug/chore/test/feature;缺省 feature 会使统计失真)
#[arg(long)]
pub r#type: Option<String>,
/// 优先级(1-5,1 最高;缺省 3)
#[arg(long)]
pub priority: Option<i64>,
/// 截止日期(Y-m-d)
#[arg(long)]
pub due: Option<String>,
/// 父任务 id(建子任务;详情侧 SubTasks 已支持展示)
#[arg(long)]
pub parent: Option<i64>,
/// 归属 sprint id
#[arg(long)]
pub sprint: Option<i64>,
}
#[derive(clap::Args)]
pub struct TaskIdArg {
pub id: i64,
}
#[derive(clap::Args)]
pub struct ReopenArgs {
pub id: i64,
/// 重开原因(必填,留痕)
#[arg(long)]
pub reason: String,
}
#[derive(clap::Args)]
pub struct BlockArgs {
pub id: i64,
/// 阻塞原因(必填,留痕)
#[arg(long)]
pub reason: String,
}
#[derive(clap::Args)]
pub struct UpdateArgs {
pub id: i64,
/// 新标题
#[arg(long)]
pub title: Option<String>,
/// 新描述
#[arg(long)]
pub description: Option<String>,
/// 类型(feature / bug / chore …)
#[arg(long)]
pub r#type: Option<String>,
/// 优先级(1-5,1 最高)
#[arg(long)]
pub priority: Option<i64>,
/// 截止日期(Y-m-d);空串=清除
#[arg(long)]
pub due: Option<String>,
/// 父任务 id(0=解除父子)
#[arg(long)]
pub parent: Option<i64>,
/// 归属 sprint id(0=移出 sprint)
#[arg(long)]
pub sprint: Option<i64>,
/// 步骤清单 JSON 文件([{text,done}];打勾=进展,顺带续租约——长任务工作流)
#[arg(long)]
pub checklist_file: Option<String>,
}
#[derive(clap::Args)]
pub struct CompleteArgs {
pub id: i64,
/// artifacts 文本
#[arg(long, conflicts_with = "artifacts_file")]
pub artifacts: Option<String>,
/// artifacts 文件路径(读取文件内容作为产出;上限 1 MiB)
#[arg(long)]
pub artifacts_file: Option<String>,
/// 备注(追加到 artifacts 末尾)
#[arg(long)]
pub note: Option<String>,
}
#[derive(clap::Args)]
pub struct LogArgs {
pub id: i64,
pub message: String,
/// success / failed(平台 schema 约束)
#[arg(long, default_value = "success")]
pub status: String,
/// 动作分类(如 build / test / progress)
#[arg(long, default_value = "progress")]
pub action: String,
}
#[derive(clap::Args)]
pub struct CommentArgs {
pub task_id: i64,
pub text: String,
}
#[derive(clap::Args)]
pub struct CommentsArgs {
pub task_id: i64,
#[arg(long)]
pub follow: bool,
/// 轮询间隔(秒)
#[arg(long, default_value_t = 3)]
pub interval: u64,
}
#[derive(clap::Args)]
pub struct NotifyArgs {
/// 只看未读
#[arg(long)]
pub unread: bool,
/// 标记指定通知已读(与 --watch 互斥)
#[arg(long)]
pub read: Option<i64>,
/// 全部标记已读
#[arg(long)]
pub read_all: bool,
/// SSE 实时流(断线指数退避重连,Ctrl-C 退出)
#[arg(long)]
pub watch: bool,
}
#[derive(clap::Args)]
pub struct DocsArgs {
/// 文件路径(vault 内相对路径;--write-file 时为写入目标)
pub path: Option<String>,
/// vault 内搜索文档(标题/标签/路径 + md 正文)
#[arg(long)]
pub search: Option<String>,
/// 只列文件路径清单
#[arg(long)]
pub list: bool,
/// 写入:本地文件 → vault 目标路径(整文件覆盖,平台自动 .history 快照)
#[arg(long)]
pub write_file: Option<String>,
/// 移动/重命名:源路径(与 --move-to 配对;目标目录自动创建,同名拒)
#[arg(long, requires = "move_to")]
pub move_from: Option<String>,
/// 移动/重命名:目标路径
#[arg(long)]
pub move_to: Option<String>,
}
#[derive(clap::Args)]
pub struct MemoryArgs {
pub key: String,
/// 读全局记忆(跨项目通用约定;项目记忆缺省)
#[arg(long)]
pub global: bool,
/// 写入值(与 --file 互斥;均缺省为读取)
#[arg(long, conflicts_with = "file")]
pub set: Option<String>,
/// 写入值从本地 UTF-8 文件读取(长值/多行推荐)
#[arg(long)]
pub file: Option<String>,
/// 有效期:30m / 12h / 7d(缺省永不过期)
#[arg(long)]
pub ttl: Option<String>,
/// 删除该记忆
#[arg(long)]
pub delete: bool,
/// 提交全局记忆提案(需 --global;待管理员审核后对所有项目生效)
#[arg(long)]
pub propose: bool,
/// 提案说明:为什么值得全局沉淀(--propose 可选)
#[arg(long)]
pub note: Option<String>,
}
#[derive(clap::Args)]
pub struct MemoriesArgs {
/// key 前缀过滤(如 conventions.)
#[arg(long)]
pub prefix: Option<String>,
}
#[derive(clap::Args)]
pub struct SearchArgs {
pub query: String,
/// 按模块过滤(如 task / doc)
#[arg(long)]
pub module: Option<String>,
}
#[derive(clap::Args)]
pub struct InitArgs {
/// 平台地址(含 /api 前缀);非交互环境必须提供
pub url: Option<String>,
}
#[derive(clap::Args)]
pub struct OpenArgs {
pub target: OpenTarget,
/// 任务 id(target=task 时必填)
pub id: Option<i64>,
}
#[derive(clap::Args)]
pub struct CompletionArgs {
pub shell: clap_complete::Shell,
}
#[derive(clap::Args)]
pub struct SkillArgs {
/// 宿主发现目录:建目录链接指向数据根正本(单一实体副本;失败回退拷贝)
#[arg(long)]
pub path: Option<String>,
/// 强制拷贝模式(不用链接;独立副本,升级需重跑)
#[arg(long)]
pub copy: bool,
/// 只列出将执行的写入/链接动作,不落盘
#[arg(long)]
pub dry_run: bool,
/// 版本总览(嵌入/正本/目标目录;不安装)
#[arg(long)]
pub list: bool,
}
#[derive(clap::ValueEnum, Clone, Debug)]
pub enum OpenTarget {
/// 任务(前端暂无直达路由,落到项目看板)
Task,
/// 项目看板
Board,
}
#[derive(clap::Args)]
pub struct DiscussArgs {
/// 讨论 id(缺省列列表;详情/回复/转任务的目标)
pub id: Option<i64>,
/// 发起讨论(--title 必填;正文 --body 或 --file)
#[arg(long)]
pub new: bool,
/// 标题(发起必填;convert 可覆盖任务标题)
#[arg(long)]
pub title: Option<String>,
/// 正文(markdown)
#[arg(long)]
pub body: Option<String>,
/// 正文/回复从本地 UTF-8 文件读取
#[arg(long)]
pub file: Option<String>,
/// 回复内容
#[arg(long)]
pub reply: Option<String>,
/// 回复内容从文件读取
#[arg(long)]
pub reply_file: Option<String>,
/// 转任务(讨论标 converted,血缘互链)
#[arg(long)]
pub convert: bool,
/// 转任务时的任务类型(bug/chore/test/feature)
#[arg(long)]
pub r#type: Option<String>,
/// 归档/恢复切换
#[arg(long)]
pub archive: bool,
}
#[derive(clap::Args)]
pub struct ReleaseArgs {
/// 创建发布(版本号项目内唯一)
#[arg(long)]
pub create: Option<String>,
/// 发布标题(缺省同版本号)
#[arg(long)]
pub title: Option<String>,
/// 发布说明文件(markdown)
#[arg(long)]
pub notes_file: Option<String>,
/// 渠道:stable(缺省)/ beta / nightly
#[arg(long)]
pub channel: Option<String>,
/// 上传文件到指定版本(可多次)
#[arg(long)]
pub upload: Option<String>,
/// 文件路径(upload 可多个;download 按名过滤)
#[arg(long)]
pub file: Option<Vec<String>>,
/// 下载指定版本(缺省全部文件)
#[arg(long)]
pub download: Option<String>,
/// 下载落盘目录(缺省当前目录)
#[arg(long, short = 'o')]
pub output: Option<String>,
/// 删除指定版本(级联清文件)
#[arg(long)]
pub delete: Option<String>,
}
#[derive(clap::Args)]
pub struct WorklogArgs {
/// 单条完整内容(直连详情端点)
#[arg(long)]
pub show: Option<i64>,
/// 写入一条(--file 或 --content;agent 需 worklog 能力位)
#[arg(long)]
pub write: bool,
/// 写入内容(与 --file 互斥使用)
#[arg(long)]
pub content: Option<String>,
/// 写入内容从本地 UTF-8 文件读取
#[arg(long)]
pub file: Option<String>,
/// 来源:manual 手写(缺省)/ tasks 草稿润色后发布
#[arg(long)]
pub source: Option<String>,
/// 生成草稿到 stdout(不落库;配 --from/--to,上限 92 天)
#[arg(long)]
pub draft: bool,
/// 起始日期 YYYY-MM-DD(含)
#[arg(long)]
pub from: Option<String>,
/// 结束日期 YYYY-MM-DD(含)
#[arg(long)]
pub to: Option<String>,
/// 列表页码
#[arg(long)]
pub page: Option<i64>,
/// 列表每页条数
#[arg(long)]
pub size: Option<i64>,
}
#[derive(clap::Args)]
pub struct QaArgs {
/// 搜索关键词(缺省列出全部,按命中数降序)
pub keyword: Option<String>,
/// 沉淀 QA:问题(同问题存在则更新答案;配合 --answer)
#[arg(long, requires = "answer")]
pub question: Option<String>,
/// 答案(markdown)
#[arg(long)]
pub answer: Option<String>,
/// 逗号分隔标签
#[arg(long)]
pub tags: Option<String>,
/// 按标签过滤
#[arg(long)]
pub tag: Option<String>,
/// 命中计数(查阅某条 QA 后调用,影响开工包 Top 排序)
#[arg(long)]
pub hit: Option<i64>,
/// 归档(过期/失效条目)
#[arg(long)]
pub archive: Option<i64>,
}
#[derive(clap::Args)]
pub struct FeedbackArgs {
/// 投递反馈到关联项目(code/名称/id)
#[arg(long)]
pub send: Option<String>,
/// 我发出的反馈(跨项目,含处理状态;不依赖目录指向)
#[arg(long)]
pub sent: bool,
/// 反馈标题
#[arg(long)]
pub title: Option<String>,
/// 反馈正文(markdown:现象/线索/怀疑点)
#[arg(long)]
pub content: Option<String>,
/// 正文从本地 UTF-8 文件读取
#[arg(long)]
pub file: Option<String>,
/// 来源任务 id(血缘可溯)
#[arg(long)]
pub task: Option<i64>,
/// 显式来源项目 id(多项目 agent 场景;优先于任务/成员/bindings 推导)
#[arg(long)]
pub source: Option<i64>,
/// 收件箱状态:open(缺省)/ all
#[arg(long)]
pub status: Option<String>,
/// 反馈转任务(缺省标题用反馈标题)
#[arg(long)]
pub convert: Option<i64>,
/// 忽略反馈(id)
#[arg(long)]
pub dismiss: Option<i64>,
/// 忽略理由(必填,回告发起方)
#[arg(long, requires = "dismiss")]
pub reason: Option<String>,
}
#[derive(clap::Args)]
pub struct TestArgs {
/// 包裹执行测试命令(-- 后接完整命令;配 --junit 顺手上报)
#[arg(long)]
pub run: bool,
/// 被包裹命令及其参数(-- 之后原样透传)
#[arg(trailing_var_arg = true, allow_hyphen_values = true)]
pub cmd: Vec<String>,
/// junit XML 路径:--run 结束后上报该文件
#[arg(long, requires = "run")]
pub junit: Option<String>,
/// 离线补传文件(junit XML 或 byte-code-pytest --bcode-dump 的 JSON)
#[arg(long)]
pub upload: Option<String>,
/// 强制格式:junit / bcode(缺省按内容嗅探)
#[arg(long)]
pub format: Option<String>,
/// 执行来源:junit(缺省按格式)/ pytest / ci / manual
#[arg(long)]
pub source: Option<String>,
/// 分支覆盖(缺省 git 探测)
#[arg(long)]
pub branch: Option<String>,
/// 环境标识(缺省 local)
#[arg(long)]
pub env: Option<String>,
/// 平台用例 ↔ 仓库 YAML 同步域
#[arg(long)]
pub cases: bool,
/// 拉取平台用例到目录
#[arg(long, requires = "cases")]
pub pull: bool,
/// 推送目录用例回平台(按 id/externalKey upsert)
#[arg(long, requires = "cases")]
pub push: bool,
/// 用例 YAML 目录(缺省 tests/cases)
#[arg(long, default_value = "tests/cases")]
pub dir: String,
/// pull 的状态过滤(缺省 active;all=不过滤)
#[arg(long)]
pub status: Option<String>,
/// push 只打印计划不写平台
#[arg(long)]
pub dry_run: bool,
}
#[derive(clap::Args)]
pub struct TopicArgs {
/// 创建专题(--title 必填;--goal/--acceptance/--doc-path 可选,默认自任执行)
#[arg(long)]
pub create: bool,
/// 专题标题(--create 必填)
#[arg(long)]
pub title: Option<String>,
/// 目标与范围(markdown)
#[arg(long)]
pub goal: Option<String>,
/// 完成判据(人验收依据)
#[arg(long)]
pub acceptance: Option<String>,
/// 关联文档路径(通常是 PRD)
#[arg(long)]
pub doc_path: Option<String>,
/// 执行 agent id(缺省自任)
#[arg(long)]
pub assignee: Option<i64>,
/// 批量写入阶段(目标专题 id;整体替换,配合 --file)
#[arg(long, requires = "file")]
pub phases: Option<i64>,
/// 阶段清单 JSON 文件([{title, detail?}],PRD 拆解导入)
#[arg(long)]
pub file: Option<String>,
/// 单专题详情(id)
#[arg(long)]
pub detail: Option<i64>,
/// 列出全部状态(缺省仅 active)
#[arg(long)]
pub all: bool,
/// 阶段推进(专题 id;配合 --phase 与 --next/--status)
#[arg(long, requires = "phase")]
pub work: Option<i64>,
/// 阶段转日常任务(专题 id;配合 --phase)
#[arg(long, requires = "phase")]
pub convert: Option<i64>,
/// 目标阶段 id(work/convert 用)
#[arg(long)]
pub phase: Option<i64>,
/// 自动推进到下一状态(pending→in_progress→done)
#[arg(long)]
pub next: bool,
/// 显式目标状态(pending/in_progress/done)
#[arg(long)]
pub status: Option<String>,
/// 专题留痕(id)
#[arg(long)]
pub log: Option<i64>,
/// 留痕类型:progress(缺省)/ handoff(交接摘要,下会话恢复点)
#[arg(long)]
pub action: Option<String>,
/// 留痕正文
#[arg(long)]
pub detail_text: Option<String>,
/// 终验收(id;平台语义为人执行)
#[arg(long)]
pub finish: Option<i64>,
/// 终验收结论:completed / abandoned
#[arg(long, requires = "finish")]
pub result: Option<String>,
}
#[cfg(test)]
mod tests {
use super::*;
use clap::CommandFactory;
/// 分组目录与实际子命令强制同步:新增命令没进目录,此测试即失败
#[test]
fn grouped_catalog_covers_every_subcommand() {
for sc in Cli::command().get_subcommands() {
let name = sc.get_name();
if name == "help" {
continue;
}
assert!(
GROUPED_CATALOG.contains(name),
"帮助分组目录缺少子命令「{name}」——请同步 GROUPED_CATALOG"
);
}
}
}