So aktivieren Sie die Tab-Vervollständigung für die .NET CLI

2025-04-17

Dieser Artikel bezieht sich auf: ✔️ .NET Core 2.1 SDK und höhere Versionen

In diesem Artikel wird beschrieben, wie Sie den Tababschluss für fünf Shells konfigurieren: PowerShell, Bash, zsh, fish und nushell. Für andere Shells lesen Sie deren Dokumentation zur Konfiguration der Tab-Vervollständigung.

Nach der Einrichtung wird der Tab-Abschluss für die .NET CLI ausgelöst, indem ein dotnet Befehl in die Shell eingegeben und dann die TAB-TASTE gedrückt wird. Die aktuelle Befehlszeile wird an den dotnet complete Befehl gesendet, und die Ergebnisse werden von der Shell verarbeitet. Sie können die Ergebnisse testen, ohne die Tab-Vervollständigung zu aktivieren, indem Sie etwas direkt an den dotnet complete Befehl senden. Beispiel:

> dotnet complete "dotnet a"
add
clean
--diagnostics
migrate
pack

Wenn dieser Befehl nicht funktioniert, stellen Sie sicher, dass .NET Core 2.0 SDK oder höher installiert ist. Wenn er installiert ist, dieser Befehl aber immer noch nicht funktioniert, stellen Sie sicher, dass der dotnet Befehl in eine Version von .NET Core 2.0 SDK oder höher aufgelöst wird. Verwenden Sie den Befehl dotnet --version, um festzustellen, in welche Version von dotnet der aktuelle Pfad aufgelöst wird. Weitere Informationen finden Sie unter Auswählen der zu verwendenden .NET-Version.

Beispiele

Hier sind einige Beispiele dafür, was die Tab-Vervollständigung bietet:

Eingabe	Wird zu	Gründe
`dotnet a⇥`	`dotnet add`	`add` ist der erste Unterbefehl alphabetisch.
`dotnet add p⇥`	`dotnet add --help`	Bei der Vervollständigung mit der TAB-TASTE werden Teilzeichenfolgen verglichen, und `--help` ist die erste Übereinstimmung in alphabetischer Reihenfolge.
`dotnet add p⇥⇥`	`dotnet add package`	Wenn Sie die TAB-TASTE ein zweites Mal drücken, wird der nächste Vorschlag angezeigt.
`dotnet package add Microsoft⇥`	`dotnet package add Microsoft.ApplicationInsights.Web`	Ergebnisse werden alphabetisch zurückgegeben.
`dotnet reference remove ⇥`	`dotnet reference remove ..\..\src\OmniSharp.DotNet\OmniSharp.DotNet.csproj`	Bei der Vervollständigung mit der TAB-TASTE wird die Projektdatei beachtet.

PowerShell

Um Tab-Vervollständigung zu PowerShell für die .NET CLI hinzuzufügen, erstellen oder bearbeiten Sie das in der Variablen $PROFILE gespeicherte Profil. Weitere Informationen finden Sie unter Erstellen Ihres Profils und Profile und Ausführungsrichtlinie.

Fügen Sie Ihrem Profil den folgenden Code hinzu:

# PowerShell parameter completion shim for the dotnet CLI
Register-ArgumentCompleter -Native -CommandName dotnet -ScriptBlock {
    param($wordToComplete, $commandAst, $cursorPosition)
        dotnet complete --position $cursorPosition "$commandAst" | ForEach-Object {
            [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
        }
}

Bash

Wenn Sie die Vervollständigung mit der TAB-TASTE für die .NET-CLI zur Bash-Shell hinzufügen möchten, fügen Sie der Datei .bashrc den folgenden Code hinzu:

# bash parameter completion for the dotnet CLI

function _dotnet_bash_complete()
{
  local cur="${COMP_WORDS[COMP_CWORD]}" IFS=$'\n' # On Windows you may need to use use IFS=$'\r\n'
  local candidates

  read -d '' -ra candidates < <(dotnet complete --position "${COMP_POINT}" "${COMP_LINE}" 2>/dev/null)

  read -d '' -ra COMPREPLY < <(compgen -W "${candidates[*]:-}" -- "$cur")
}

complete -f -F _dotnet_bash_complete dotnet

zsh

Wenn Sie die Vervollständigung mit der TAB-TASTE für die .NET-CLI zur zsh-Shell hinzufügen möchten, fügen Sie der Datei .zshrc den folgenden Code hinzu:

# zsh parameter completion for the dotnet CLI

_dotnet_zsh_complete()
{
  local completions=("$(dotnet complete "$words")")

  # If the completion list is empty, just continue with filename selection
  if [ -z "$completions" ]
  then
    _arguments '*::arguments: _normal'
    return
  fi

  # This is not a variable assignment, don't remove spaces!
  _values = "${(ps:\n:)completions}"
}

compdef _dotnet_zsh_complete dotnet

Fisch

Wenn Sie die Vervollständigung mit der TAB-TASTE für die .NET-CLI der fish-Shell hinzufügen möchten, fügen Sie der Datei config.fish den folgenden Code hinzu:

complete -f -c dotnet -a "(dotnet complete (commandline -cp))"

nushell

Um die Vervollständigung mit der TAB-TASTE zu Ihrer nushell für .NET CLI hinzuzufügen, fügen Sie Folgendes am Anfang Ihrer config.nu-Datei hinzu:

let external_completer = { |spans|
    {
        dotnet: { ||
            dotnet complete (
                $spans | skip 1 | str join " "
            ) | lines
        }
    } | get $spans.0 | each { || do $in }
}

Suchen Sie dann im config-Datensatz den Abschnitt completions, und fügen Sie den zuvor definierten external_completer in external hinzu:

let-env config = {
    # your options here
    completions: {
        # your options here
        external: {
            # your options here
            completer: $external_completer # add it here
        }
    }
}

Freigeben über