跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.nudgen.net/llms.txt

Use this file to discover all available pages before exploring further.

​
概述

Nudgen CLI 采用 AI 优先 (AI-First) 的方法设计。虽然它为人类提供了美观的 TUI，但每个命令也针对机器对机器通信进行了优化。

​
智能体模式

当 AI 智能体（如 Claude、GPT 或专门的自动化智能体）使用 CLI 时，应遵循以下模式：
  1. JSON 输出：在每个命令后添加 --json 以获取机器可解析的数据。
  2. 上下文感知：在执行操作之前，始终验证团队上下文。
  3. 非交互式：使用标志 (flags) 绕过交互式 TUI 提示。

​
JSON 自动化

每个列表和状态命令都支持 --json 标志。这会返回一个干净的 JSON 结构，而不是格式化的表格。 
# 以 JSON 格式获取所有营销活动
nudgen campaigns list --json

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

​
智能体的多租户工作流

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

​
智能体开发人员的最佳实践

  • 错误处理：监控 CLI 命令的退出代码。非零退出代码表示发生错误（验证、网络或身份验证错误）。
  • 速率限制：CLI 与 Nudgen API 通信。确保您的智能体脚本能够优雅地处理潜在的速率限制。
  • 静默模式：如果某个命令并非对每个提示都支持特定标志，请确保您的智能体能够处理 stdout/stderr 流，而不会陷入 TUI 循环。