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

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

​
エージェントパターン

AIエージェント（Claude、GPT、または特殊な自動化エージェントなど）がCLIを使用する場合、以下のパターンに従う必要があります：
  1. JSON出力: すべてのコマンドに --json を追加して、マシンが解析可能なデータを取得します。
  2. コンテキスト認識: 操作を実行する前に、常にチームコンテキストを確認してください。
  3. 非対話形式: フラグを使用して、対話型の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コマンドの終了コードを監視してください。0以外の終了コードはエラー（検証、ネットワーク、または認証）を示します。
  • レート制限: CLIはNudgen APIと通信します。エージェントスクリプトが潜在的なレート制限を適切に処理できるようにしてください。
  • サイレントモード: コマンドがすべてのプロンプトに対して特定のフラグをサポートしていない場合、エージェントがTUIループで停止することなくstdout/stderrストリームを処理できることを確認してください。