Skip to content

README.md

Latest commit

 

History

History
161 lines (114 loc) · 4.66 KB

README.md

File metadata and controls

161 lines (114 loc) · 4.66 KB

chaitin-cli

CI Release Go Version License

长亭安全产品统一命令行工具

English README

演示

CloudWalker

asciicast

T-Answer

asciicast

SafeLine

asciicast

SafeLine-CE

asciicast

DDR

asciicast

X-Ray

asciicast

配置

将各产品的连接信息写入 ./config.yaml：

cloudwalker:
  url: https://cloudwalker.example.com/rpc
  api_key: YOUR_API_KEY

tanswer:
  url: https://tanswer.example.com
  api_key: YOUR_API_KEY

# chaitin-cli ddr get-api-token --url https://ddr.example.com:8443 --jwt-token "YOUR_JWT_TOKEN" 可以直接获取 url & api_key & company_id
ddr:
  url: "https://ddr.example.com:8443/qzh/api/v1"
  api_key: "YOUR_API_KEY"
  company_id: "YOUR_COMPANY_ID"

xray:
  url: https://xray.example.com/api/v2
  api_key: YOUR_API_KEY

也可以把同样的配置放到环境变量或本地 .env 文件中。变量命名规则为 <PRODUCT>_<FIELD>：

cloudwalker.url      -> CLOUDWALKER_URL
cloudwalker.api_key  -> CLOUDWALKER_API_KEY
tanswer.url          -> TANSWER_URL
tanswer.api_key      -> TANSWER_API_KEY
ddr.url              -> DDR_URL
ddr.api_key          -> DDR_API_KEY
ddr.company_id       -> DDR_COMPANY_ID
xray.url             -> XRAY_URL
xray.api_key         -> XRAY_API_KEY
safeline-ce.url      -> SAFELINE_CE_URL
safeline-ce.api_key  -> SAFELINE_CE_API_KEY
safeline.url         -> SAFELINE_URL
safeline.api_key     -> SAFELINE_API_KEY

.env 示例：

SAFELINE_URL=https://safeline.example.com
SAFELINE_API_KEY=YOUR_API_KEY
XRAY_URL=https://xray.example.com/api/v2
XRAY_API_KEY=YOUR_API_KEY

优先级为 flags > environment/.env > config.yaml

可以通过根命令的 -c 或 --config 指定其他配置文件。这在切换多个产品实例时很有用，例如多个 SafeLine 环境：

chaitin-cli -c ./configs/safeline-prod.yaml safeline stats overview
chaitin-cli -c ./configs/safeline-staging.yaml safeline stats overview

支持 dry-run 的命令可以使用根级别的 --dry-run：

chaitin-cli --dry-run xray plan PostPlanFilter --filterPlan.limit=10

项目结构

main.go                # 主入口和 CLI 装配逻辑
products/<name>/       # 每个产品一个独立目录
Taskfile.yml           # 构建、运行、检查任务

添加新产品

在 products 目录下新增产品实现

新增产品检查清单：

  • 在 main.go 中导入产品包
  • 在 newApp() 中通过 a.registerProductCommand(...) 注册命令
  • 如果 NewCommand() 返回 (*cobra.Command, error)，需要在注册前处理错误
  • 如果产品依赖 config.yaml 或根级运行时参数，在产品包里实现 ApplyRuntimeConfig(...)，并从 main.go 的 wrapProductCommand() 中调用
  • 产品配置应在产品包内部从 config.Raw 解码，不要把产品字段解析逻辑塞进根命令

BusyBox 风格调用

同一个二进制可以通过软链接，或者直接重命名后，以子命令名直接调用：

task build
ln -s ./bin/chaitin-cli ./chaitin
./chaitin

等价于：

./bin/chaitin-cli chaitin

AI Agent Skill

本项目提供了 AI Agent skill，安装后 AI Agent（Claude Code、Cursor 等）可以直接调用 chaitin-cli 命令管理长亭安全产品。

npx skills add chaitin/chaitin-cli

安装后，向 AI Agent 描述需求即可，例如：

  • "帮我查看 SafeLine 最近的攻击日志"
  • "在 X-Ray 中创建一个扫描任务"
  • "列出 CloudWalker 中的漏洞事件"

常用任务

task build
task run:chaitin
task fmt
task lint
task test
task package GOOS=linux GOARCH=amd64