跳转到主要内容

​
概述

Nudgen CLI 采用 AI 优先 的设计理念。在为人类用户提供精美 TUI 的同时，所有命令也针对机器间通信进行了优化。

​
Agent 模式

当 AI Agent（如 Claude、GPT 或专门的自动化 Agent）使用 CLI 时，应遵循以下模式：
  1. JSON 输出：在每个命令后附加 --json 以获取机器可解析的数据。
  2. 上下文感知：在执行操作前，务必验证团队上下文。
  3. 非交互式：使用相关参数绕过交互式 TUI 提示。

​
JSON 自动化

所有列表和状态命令均支持 --json 参数。这会返回清晰的 JSON 结构，而非格式化的表格。 
# 以 JSON 格式获取所有营销活动
nudgen campaigns list --json

# 获取当前团队中的联系人
nudgen contacts list --json

​
面向 Agent 的多团队工作流

由于 Nudgen 支持多个团队，Agent 在操作资源前必须确保处于正确的团队上下文中。 推荐的工作流程：
  1. 检查当前团队： 
    nudgen teams current --json
  2. 切换团队（如果需要）： 如果上一步中的 id 与目标团队不符，请进行切换： 
    nudgen teams switch <target-team-id>
  3. 执行数据命令： 继续执行 campaigns、contacts 或 brand 等命令。

​
Agent 开发最佳实践

  • 错误处理：监控 CLI 命令的退出代码。非零退出代码表示发生了错误（验证失败、网络问题或授权问题）。
  • 频率限制 (Rate Limiting)：CLI 与 Nudgen API 通信。确保您的 Agent 脚本能优雅地处理潜在的频率限制。
  • 静默模式：如果某个命令在所有提示点都不支持特定参数，请确保您的 Agent 能够处理 stdout/stderr 流，而不会卡在 TUI 循环中。