uip-Vervollständigung

uip completion installiert, gibt aus oder entfernt die Shell-Registerkartenvervollständigung für uip. Es unterstützt bash, zsh, iff und pwsh (PowerShell). Interaktiv beim Aufruf ohne explizites Shell-Argument in einem Tty; Sie können das Vervollständigungsskript auf sdout ausführen, wenn ein Shell-Argument angegeben wird oder wenn sdout kein Tty ist.

Die vollständige Anleitung, einschließlich der Beispiele für die rc-Datei pro Shell und der Proxy-Hinweise, finden Sie unter Installieren der UiPath CLI – Shell-Vervollständigung aktivieren.

Zusammenfassung

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

Alle Flags berücksichtigen die globalen Optionen (--output, --output-filter, --log-level, --log-file). Austrittscodes folgen dem Standardvertrag; Das Abbrechen einer interaktiven Bestätigungsaufforderung wird mit 130 (Benutzer abbrechen) beendet.

Argumente

• [shell] (optional) – Einer von bash, zsh, fish, pwsh (Alias: powershell). Wenn keine Angabe erfolgt, wird die Shell automatisch von $SHELL / $PSModulePath / der Plattform erkannt.

Optionen

• --print – Geben Sie den Zielpfad der rc-Datei und den zu schreibenden Block aus, ohne das Dateisystem zu ändern. Nützlich für die Vorschau der Aufgaben von uip completion .
• --uninstall – Entfernen Sie den verwalteten Vervollständigungsblock (oder fürMails die generierte Vervollständigungsdatei), anstatt ihn zu installieren. Idempotent – ein No-Op, wenn der Block bereits fehlt.

Verhalten

Der Befehl folgt einer einfachen Drei-Verzweigungen-Regel:

1. Interaktive Installation (kein Shell-Argument, Standardwert ist ein Tty) – erkennt automatisch die Shell, gibt die Ziel-RC-Datei aus und fordert Sie vor dem Schreiben zur Bestätigung auf. Mit Strg-C abbrechen, um 130 zu beenden.

2. Skript-Dump (explizites Shell-Argument oder „stdout“ ist kein Tty) – schreibt das generierte Vervollständigungsskript nach „stdout“. Leiten Sie es in Ihre rc-Datei um, oder geben Sie es direkt als Quelle aus:

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

3. Uninstall (--uninstall) – Entfernt den verwalteten Block unabhängig vom Tty-Status.

Beispiele

# 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

Datenform (--output json)

Bei erfolgreicher Installation:

{
  "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."
    ]
  }
}

Unter --print:

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

Unter --uninstall:

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

Fehlermodi

• Nicht unterstützte Shell – Failure mit Message: "Unsupported shell: <name>", Anweisungen zur Verwendung von einem von bash, zsh, fish, pwsh.
• Shell-Sonderzeichen in einem Befehlsnamen – Failure aus dem zsh/Fish-Generator; Benennen Sie den fehlerhaften Befehl um oder öffnen Sie ein Problem.
• Kein Schreibzugriff auf die rc-Datei – Failure mit Anweisungen zum Überprüfen von Berechtigungen für den Zielpfad.
• Benutzer bricht die Bestätigungsaufforderung ab – beendet 130 (kein Umschlag).

Dynamische Flag-Wert-Vervollständigung

Die statische Vervollständigung (Unterbefehlsnamen, Optionsnamen) funktioniert auf allen vier Shells. Die dynamische Flag-Wert-Vervollständigung – z. B. uip or packages upload --package-name <TAB> , die Live-Paketnamen vorschlägt – ist derzeit nur zsh und erfordert jq auf PATH. Ohne jq werden dynamische Kandidaten im Hintergrund unterdrückt; Der Installationsschritt gibt in diesem Fall einen Hinweis im notes[] -Array aus.

Statischer Snapshot: Nach jedem Upgrade erneut ausführen

Das generierte Vervollständigungsskript ist eine statische Momentaufnahme der Unterbefehlsnamen und Optionsnamen, die beim Ausführen von uip completion bekannt waren. Er wird beim Shell-Start nicht erneut generiert. Führen Sie nach einer der folgenden Aktionen uip completion erneut aus, damit neu hinzugefügte Verben und Flags in der Registerkartenvervollständigung angezeigt werden:

• npm install -g @uipath/cli@<new-version> – der Host ist fehlgeschlagen, neue globale Flags oder Befehle der obersten Ebene können vorhanden sein.
• uip tools install <new-tool> – Ein Tool, das Sie nicht hatten, wird jetzt installiert; Sein Alias und seine Verben sind noch nicht im Skript enthalten.
• uip tools update – installierte Tools werden in einen neuen Minor verschoben; Möglicherweise wurden neue Verben oder Flags hinzugefügt.

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

Ohne Aktualisierung funktionieren die neuen Verben weiterhin in der Befehlszeile – sie werden nur nicht von <TAB> vorgeschlagen. Die dynamische Flag-Value-Vervollständigung (der Nur-zsh-Fall oben) ist das einzige Element, das zur Runtime aufgelöst wird; alles andere muss aktualisiert werden.

Zugehörig

• Installing UiPath CLI – Shell-Vervollständigung aktivieren – Anleitung für die Einrichtung pro Shell und Fehlerbehebung.
• Fehlerbehebung – Die Registerkartenvervollständigung wird nicht abgeschlossen – häufige Probleme während der Installation.
• Skriptingmuster – Unterdrücken interaktiver Prompts – Vermeiden des Bestätigungsprompts in CI.

Siehe auch

• uip Tools – uip completion spiegelt die Unterbefehle der installierten Tools wider; Führen Sie die Aktion nach uip tools install erneut aus, wenn Sie die Vervollständigung für neu installierte Befehle möchten.
• Globale Optionen – --output, --output-filter, --log-level, --log-file.
• Austrittscodes – der Standardvertrag plus 130 für die Beendigung durch den Benutzer.