uip codedagent

uip codedagent は、Python ベースの UiPath のコード化されたエージェント ワークフローへの薄い橋渡し役です。適切な Python インタプリタを検出し、 uipath Python パッケージがインストールされていることを確認し、他のすべてのサブコマンドを Python CLI に転送するため、new、dev、pack、publish、およびその他のライフサイクル動詞は、このツールではなく Python パッケージから取得されます。

シンラッパーとフルツールの違いについては、 ツール (プラグイン) を参照してください。

概要

uip codedagent setup [--force]
uip codedagent <any-command> [args...]

setup コマンドと転送コマンドの両方で、 グローバル オプション (--output、 --output-filter、 --log-level、 --log-file) が優先されます。終了コードは 標準コントラクトに従います。

uip codedagent の設定

Python を検出し、 uipath パッケージがインストールされていることを確認します。結果はユーザーごとのファイルにキャッシュされるため、後続の codedagent コマンドでPythonバイナリを即座に解決できます。

引数

設定はありません。

オプション

• --force — キャッシュされた結果が存在する場合でも、検出を再実行します。

例

uip codedagent setup
uip codedagent setup --force

Data shape (--output json)

{
  "Code": "CodedAgentsSetup",
  "Data": {
    "PythonPath": "/usr/bin/python3.11",
    "Package": "uipath",
    "PackageInstalled": "Yes",
    "PackageVersion": "1.0.0"
  }
}

Environment checks

• 許可される Python のバージョンは、環境変数 ( PYTHON_TOOL_PYTHON_VERSIONS) を使用して構成されます。リストが空の場合、セットアップ時に Failure が発生します。
• 現在の作業ディレクトリに .venv ディレクトリが存在するが、仮想環境がアクティブになっていない場合、セットアップは実行を拒否し、最初にアクティブにすることを提案します(Windowsでは.venv\Scripts\activate 、他の場所では source .venv/bin/activate )。

転送されるコマンド

setup、exec、help以外のサブコマンドは、codedagent exec <subcommand> ...としてuipath Python CLI に透過的に転送されます。これは、Python パッケージの独自のコマンドサーフェス ( 、 new、 dev、 の run、 pack、 publish、およびそれが出荷する他のもの -- に uip codedagentを介してアクセスできることを意味します。

例

# Hand off to the Python CLI's new command
uip codedagent new my-agent

# Run the Python CLI's help for a sub-verb
uip codedagent init --help

# Execute a dev loop defined by the Python package
uip codedagent dev

注:

これらのコマンドは uipath Python パッケージによって定義されるため、そのフラグと出力の形状は、CLI の標準の Code/Data エンベロープではなく、そのパッケージが出力するものです。ここで CLI を移送として扱います。引数サーフェスでは、 uip codedagent help または uip codedagent <command> --helpを実行し、どちらも Python に転送されます。

認証リレー:転送する前に、CLI は uip login によって作成されたセッションを読み取り、次の環境変数を Python サブプロセスに挿入して、SDK が自動的に取得するようにします。

• UIPATH_ACCESS_TOKEN
• UIPATH_URL ( <baseUrl>/<org>/<tenant>として構成)
• UIPATH_ORGANIZATION_ID、UIPATH_ORGANIZATION_NAME
• UIPATH_TENANT_ID、UIPATH_TENANT_NAME

ログインしていない場合でも、転送は機能します。Python CLI は、これらの変数なしで実行されます。

ブロックされたフラグ: フォワーダは、いくつかの破壊的な Python サブコマンド (正確なリストはツールの構成レイヤーによって強制されます) に --force を渡すことを拒否し、それを見つけると ValidationError を出力します。エラー メッセージが示唆する非--force 代替手段を使用してください。

終了コード

標準の 終了コード が適用されます。転送されたサブプロセスの終了コードは親シェルに直接中継されるため、Python側の障害は同じゼロ以外のステータスで uip codedagent 終了します。

関連

• ツール (プラグイン) — シンラッパーツールモデル。
• uip login — Python ランタイムにリレーされるセッションを作成します。
• uip tools — codedagent-toolパッケージ自体をインストール、更新、アンインストールします。