From b0325615ebf33ea89d5752f149e3dcbb811a8783 Mon Sep 17 00:00:00 2001 From: Louis Deconinck Date: Fri, 11 Sep 2026 08:11:07 +0200 Subject: [PATCH] docs: document shell completions Signed-off-by: Louis Deconinck --- README.de.md | 18 ++++++++++++++++++ README.es.md | 18 ++++++++++++++++++ README.fr.md | 18 ++++++++++++++++++ README.md | 18 ++++++++++++++++++ README.pt-BR.md | 18 ++++++++++++++++++ 5 files changed, 90 insertions(+) diff --git a/README.de.md b/README.de.md index 6b7575b..abf668d 100644 --- a/README.de.md +++ b/README.de.md @@ -47,6 +47,24 @@ Windows). Lieber erst ansehen? Lade ein Archiv von der [Release-Seite](https://github.com/getsotto/sotto/releases) herunter und verifiziere es manuell gemäß [SECURITY.md](SECURITY.md), oder baue aus den Quellen (siehe [Entwicklung](#entwicklung)). +### Shell-Vervollständigungen + +`sotto completions ` gibt ein Vervollständigungsskript auf der Standardausgabe aus. Zum Beispiel: + +```sh +# bash +sotto completions bash > ~/.local/share/bash-completion/completions/sotto + +# zsh (add the directory to fpath in ~/.zshrc first) +sotto completions zsh > ~/.zfunc/_sotto + +# fish +sotto completions fish > ~/.config/fish/completions/sotto.fish +``` + +Release-Tarballs und -zips enthalten ebenfalls die passenden Dateien `completions/sotto.*`, +falls du sie lieber direkt kopieren möchtest. + ### GitHub Actions Für GitHub Actions verwende die [Sotto-Setup-Action](https://github.com/getsotto/sotto-action), um ein exaktes diff --git a/README.es.md b/README.es.md index 85a321a..a834c91 100644 --- a/README.es.md +++ b/README.es.md @@ -47,6 +47,24 @@ Windows). ¿Prefieres revisar antes? Descarga un archivo comprimido desde la [página de versiones](https://github.com/getsotto/sotto/releases) y verifícalo manualmente según [SECURITY.md](SECURITY.md), o compila desde el código fuente (consulta [Desarrollo](#desarrollo)). +### Completado del shell + +`sotto completions ` muestra un script de completado en la salida estándar. Por ejemplo: + +```sh +# bash +sotto completions bash > ~/.local/share/bash-completion/completions/sotto + +# zsh (add the directory to fpath in ~/.zshrc first) +sotto completions zsh > ~/.zfunc/_sotto + +# fish +sotto completions fish > ~/.config/fish/completions/sotto.fish +``` + +Los tarballs y zips de las versiones también contienen los archivos correspondientes `completions/sotto.*` +si prefieres copiarlos directamente. + ### GitHub Actions Para GitHub Actions, usa la [acción Sotto Setup](https://github.com/getsotto/sotto-action) para diff --git a/README.fr.md b/README.fr.md index e401e28..b9df3a2 100644 --- a/README.fr.md +++ b/README.fr.md @@ -47,6 +47,24 @@ Windows). Vous préférez vérifier d'abord ? Récupérez une archive sur la [page des versions](https://github.com/getsotto/sotto/releases) et vérifiez-la manuellement selon [SECURITY.md](SECURITY.md), ou compilez depuis les sources (voir [Développement](#développement)). +### Complétions du shell + +`sotto completions ` affiche un script de complétion sur la sortie standard. Par exemple : + +```sh +# bash +sotto completions bash > ~/.local/share/bash-completion/completions/sotto + +# zsh (add the directory to fpath in ~/.zshrc first) +sotto completions zsh > ~/.zfunc/_sotto + +# fish +sotto completions fish > ~/.config/fish/completions/sotto.fish +``` + +Les tarballs et zips des releases contiennent également les fichiers correspondants `completions/sotto.*` +si vous préférez les copier directement. + ### GitHub Actions Pour GitHub Actions, utilisez l'[action Sotto Setup](https://github.com/getsotto/sotto-action) pour diff --git a/README.md b/README.md index bc30c4e..153ae59 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,24 @@ Windows). Prefer to look first? Grab an archive from the [releases page](https://github.com/getsotto/sotto/releases) and verify it manually per [SECURITY.md](SECURITY.md), or build from source (see [Developing](#developing)). +### Shell completions + +`sotto completions ` prints a completion script to stdout. For example: + +```sh +# bash +sotto completions bash > ~/.local/share/bash-completion/completions/sotto + +# zsh (add the directory to fpath in ~/.zshrc first) +sotto completions zsh > ~/.zfunc/_sotto + +# fish +sotto completions fish > ~/.config/fish/completions/sotto.fish +``` + +Release tarballs and zips also contain the matching `completions/sotto.*` files if you prefer to +copy them directly. + ### GitHub Actions For GitHub Actions, use the [Sotto Setup action](https://github.com/getsotto/sotto-action) to diff --git a/README.pt-BR.md b/README.pt-BR.md index 781ce35..0dd554c 100644 --- a/README.pt-BR.md +++ b/README.pt-BR.md @@ -47,6 +47,24 @@ Windows). Prefere conferir antes? Baixe um arquivo compactado na [página de releases](https://github.com/getsotto/sotto/releases) e verifique manualmente conforme [SECURITY.md](SECURITY.md), ou compile do código-fonte (consulte [Desenvolvimento](#desenvolvimento)). +### Autocompletar do shell + +`sotto completions ` imprime um script de autocompletar na saída padrão. Por exemplo: + +```sh +# bash +sotto completions bash > ~/.local/share/bash-completion/completions/sotto + +# zsh (add the directory to fpath in ~/.zshrc first) +sotto completions zsh > ~/.zfunc/_sotto + +# fish +sotto completions fish > ~/.config/fish/completions/sotto.fish +``` + +Os tarballs e zips das releases também contêm os arquivos correspondentes `completions/sotto.*` +se você preferir copiá-los diretamente. + ### GitHub Actions Para GitHub Actions, use a [action Sotto Setup](https://github.com/getsotto/sotto-action) para