メインコンテンツへスキップ

​
概要

Nudgen CLIはAIファーストのアプローチで設計されています。人間向けに美しいTUIを提供すると同時に、すべてのコマンドがマシン間通信用に最適化されています。

​
エージェントパターン

AIエージェント（Claude、GPT、または専用の自動化エージェントなど）がCLIを使用する場合、以下のパターンに従う必要があります：
  1. JSON出力: すべてのコマンドに--jsonを付加して、マシン可読なデータを取得します。
  2. コンテキスト認識: 操作を実行する前に必ずチームコンテキストを確認してください。
  3. 非対話型: 対話的なUIプロンプトをバイパスするために適切なフラグを使用します。

​
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コマンドの終了コードを監視してください。0以外の終了コードは、エラー（バリデーション、ネットワーク、認証など）を示します。
  • レート制限: CLIはNudgen APIと通信します。エージェントスクリプトがレート制限を適切に処理できるようにしてください。
  • サイレントモード: すべてのプロンプトに対して特定のフラグが提供されていない場合は、エージェントがTUIループに陥ることなくstdout/stderrストリームを処理できるようにしてください。