tapd-ai-cli: Instructions file for Codex

AGENTS.md

本文件为 AI 编码助手在此仓库中工作时提供指导。

项目简介

tapd-ai-cli 是一个 Go CLI 工具，通过 TAPD（腾讯敏捷产品研发平台）Open API 与 TAPD 平台交互。目标用户是 AI Agent（Claude Code、GPT-4o 等），而非人类用户。所有输出均针对最小 token 消耗进行优化。

技术栈

• Go 1.24+，CLI 框架：spf13/cobra
• SDK：github.com/studyzy/tapd-sdk-go（独立仓库，仅依赖标准库）
• HTML→Markdown：github.com/JohannesKaufmann/html-to-markdown/v2（CLI 层，SDK 返回原始 HTML）
• Markdown→HTML：github.com/gomarkdown/markdown（create/update 时将用户输入转为 TAPD 所需的 HTML）
• 认证：TAPD_ACCESS_TOKEN（Bearer，推荐）或 TAPD_API_USER/TAPD_API_PASSWORD（Basic Auth）
• 许可证：Apache 2.0

构建与开发命令

# 构建（版本号从 git tag 注入）
make build          # go build -ldflags "-X ...Version=$(git describe)" -o tapd ./cmd/tapd/
make build-cross    # 交叉编译，需设 GOOS/GOARCH

# 安装到 $GOPATH/bin
make install

# 测试
make test           # go test -race ./...
go test ./internal/cmd -run TestStoryList   # 运行单个测试
make test-integration                       # go test ./... -v -run "TestIntegration" -count=1

# 覆盖率（目标 >= 60%）
make coverage       # test-coverage + go tool cover -func

# 代码格式化与检查
make fmt            # gofmt -w . && goimports -w .
make lint           # go vet ./... && goimports -l .

# 安装开发工具
make tools          # go install goimports

# 清理
make clean

架构

目录结构

cmd/tapd/           # 入口 main.go
internal/
  cmd/              # Cobra 命令定义（每个资源一个文件），消费 SDK
    root.go         # 根命令、全局标志、客户端初始化、通用 helpers
    story.go        # 需求 CRUD 命令（典型命令模板）
    bug.go          # 缺陷管理
    task.go         # 任务管理
    launch.go       # 发布评审
    help.go         # --help 输出紧凑参考卡生成逻辑
    markdown.go     # htmlToMarkdown / markdownToHTML 双向转换
    id_expand.go    # 短 ID → TAPD 长 ID 自动展开
    url.go          # 从 TAPD URL 解析条目类型并查询详情
    ...
  config/           # 凭据管理（CLI flags > env > ./.tapd.json > ~/.tapd.json）
  output/           # JSON/Markdown 输出格式化、退出码常量

SDK 独立仓库：github.com/studyzy/tapd-sdk-go，本地联调可用 go.work（已 gitignore）。

命令树

tapd
├── auth      login
├── workspace list | switch <id> | info
├── story     list | show <id> | create | update <id> | count | todo
├── task      list | show <id> | create | update <id> | count | todo
├── bug       list | show <id> | create | update <id> | count | todo
├── wiki      list | show <id> | create | update
├── iteration list | create | update | count
├── comment   list | add | update | count
├── tcase     list | create | batch-create
├── timesheet list | add | update
├── launch    list | count | create | update <id> | templates | fields | logs
├── workflow  transitions | status-map | last-steps
├── relation  bugs | create
├── url       <tapd-url>
├── skill     init
└── ...       release, attachment, category, custom-field, label, module, user, report 等

全局标志：--workspace-id <id>, --json, --pretty, --no-comments