UIP の完了

uip completion uipのシェル タブ補完をインストール、印刷、または削除します。bash、zsh、fish、pwsh (PowerShell) がサポートされています。TTY で明示的なシェル引数なしで呼び出された場合にインタラクティブ。シェル引数が与えられたとき、または stdout が TTY でない場合に、完了スクリプトを stdout にダンプします。

シェルごとの rc ファイルの例やプロキシに関する注意事項など、完全なチュートリアルについては、「 UiPath CLI のインストール — シェル補完の有効化」をご覧ください。

概要

uip completion [shell] [--print] [--uninstall]

すべてのフラグには 、グローバル オプション (--output、 --output-filter、 --log-level、 --log-file) が適用されます。終了コードは 標準のコントラクトに従います。対話型の確認プロンプトをキャンセルすると、 130 (ユーザーによるキャンセル) で終了します。

引数

• [shell](任意):bash、zsh、fish、pwshのいずれか(別名:powershell)。省略すると、シェルは $SHELL / $PSModulePath /プラットフォームから自動検出されます。

オプション

• --print — ファイルシステムを変更せずに、ターゲットの rc ファイルパスと書き込まれるブロックを出力します。uip completionが何をするかをプレビューするのに便利です。
• --uninstall — インストールする代わりに、管理された完了ブロック (または fish の場合は生成された完了ファイル) を削除します。べき等 — ブロックがすでに存在しない場合は何もしません。

動作

このコマンドは、単純な 3 分岐ルールに従います。

1. 対話型インストール (シェル引数なし、stdout は TTY ) — シェルを自動検出し、対象の rc ファイルを出力し、書き込み前に確認を求めます。Ctrl-C でキャンセルして 130を終了します。

2. スクリプトダンプ (明示的なシェル引数、 または stdoutはTTYではありません)—生成された補完スクリプトをstdoutに書き込みます。rcファイルにパイプするか、直接ソースします。

   uip completion zsh >> ~/.zshrc
   uip completion bash >> ~/.bashrc
   uip completion fish > ~/.config/fish/completions/uip.fish
   uip completion pwsh >> $PROFILE
   

3. アンインストール (--uninstall): TTY の状態に関係なく、管理ブロックを削除します。

例

# Interactive install — auto-detect shell, prompt, write rc file
uip completion

# Preview without touching the filesystem
uip completion --print

# Dump the zsh script to a specific rc file
uip completion zsh >> ~/.zshrc

# Dump the PowerShell script to your profile
uip completion pwsh >> $PROFILE

# Remove the managed completion block
uip completion --uninstall

データシェイプ(--output json)

インストールが成功した場合:

{
  "Code": "CompletionInstalled",
  "Data": {
    "shell": "zsh",
    "path": "/Users/alice/.zshrc",
    "action": "appended",
    "notes": [
      "Dynamic flag-value completion (e.g. --package-name <TAB>) requires `jq` on PATH; without it, those candidates are suppressed."
    ]
  }
}

--print時 :

{
  "Code": "CompletionPrint",
  "Data": {
    "shell": "zsh",
    "path": "/Users/alice/.zshrc",
    "mode": "block",
    "content": "# >>> uip completion >>>\n…generated script…\n# <<< uip completion <<<"
  }
}

--uninstall時 :

{
  "Code": "CompletionUninstalled",
  "Data": {
    "shell": "zsh",
    "path": "/Users/alice/.zshrc",
    "action": "removed"
  }
}

故障モード

• サポートされていないシェル — Message: "Unsupported shell: <name>"、bash、zsh、fish、pwshのいずれかを使用するための命令Failure。
• コマンド名のシェル特殊文字 — zsh / fishジェネレーターからの Failure 。問題のあるコマンドの名前を変更するか、問題を開きます。
• rcファイルへの書き込み権限がない — ターゲットパスの権限を確認する手順 Failure 。
• ユーザーが確認プロンプトをキャンセルし、130を終了します (エンベロープなし)。

フラグ値の動的な補完

静的補完 (サブコマンド名、オプション名) は、4 つのシェルすべてで機能します。フラグ値の動的な補完 (ライブ パッケージ名の提案など) uip or packages upload --package-name <TAB>、現在は zsh のみであり、PATHでjqが必要です。jqがない場合、動的候補はサイレントに抑制されます。これに該当する場合、インストール手順では notes[] 配列にメモが出力されます。

静的スナップショット: アップグレードのたびに再実行

生成された補完スクリプトは、uip completion実行時に認識されていたサブコマンド名とオプション名の静的スナップショットです。シェルの起動時には再生成されません。次のいずれかの操作を行った後、 uip completion を再実行すると、新しく追加された動詞とフラグがタブ補完に表示されます。

• npm install -g @uipath/cli@<new-version> — ホストがバンプした場合、新しいグローバルフラグまたはトップレベルコマンドが存在する可能性があります。
• uip tools install <new-tool> — 持っていなかったツールがインストールされました。その別名と動詞はまだ脚本にありません。
• uip tools update — インストールされたツールが新しい MINOR に移動されました。新しい動詞やフラグが追加されている可能性があります。

uip completion              # interactive — refreshes the existing block
uip completion zsh >> ~/.zshrc   # or pipe into the rc file directly

更新しなくても、新しい動詞はコマンドラインで機能します—それらは <TAB>によって提案されません。動的なフラグ値補完 (上記の zsh のみの場合) は、実行時に解決される 1 つの部分です。他のすべてはリフレッシュする必要があります。

関連

• UiPath CLI をインストールする — シェル補完を有効にする — シェルごとのセットアップ、チュートリアル、トラブルシューティングを行います。
• トラブルシューティング — タブ補完が完了しない — インストール時の一般的な問題。
• スクリプティングパターン — 対話型プロンプトの抑制 — CI での確認プロンプトの回避。

参照

• uip tools — インストールしたツールのサブコマンドを反映し uip completion 。新しくインストールしたコマンドの完了が必要な場合は、 uip tools install 後に再実行してください。
• グローバルオプション — --output、 --output-filter、 --log-level、 --log-file。
• 終了コード — 標準契約とユーザーキャンセルの 130 。