From a8e52d6c11ce316a74c8a01d3a265a252f9a0650 Mon Sep 17 00:00:00 2001 From: Miguel Prieto Date: Fri, 10 Oct 2025 11:20:00 -0300 Subject: [PATCH] Added shell completion documentation to Readme --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index 5d2384d..a5b8388 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,42 @@ mv orkes_* /usr/local/bin/orkes orkes --version ``` +### Shell Completion + +Enable tab completion for commands, flags, and arguments: + +**Zsh (macOS default):** +```bash +# One-time setup +orkes completion zsh > $(brew --prefix)/share/zsh/site-functions/_orkes + +# Restart your shell or run: +source ~/.zshrc +``` + +**Bash:** +```bash +# Linux +orkes completion bash > /etc/bash_completion.d/orkes + +# macOS +orkes completion bash > $(brew --prefix)/etc/bash_completion.d/orkes + +# Then restart your shell +``` + +**Fish:** +```bash +orkes completion fish > ~/.config/fish/completions/orkes.fish +``` + +**PowerShell:** +```powershell +orkes completion powershell | Out-String | Invoke-Expression +``` + +After installing, you'll get tab completion when typing `orkes `. + ## Configuration The CLI can be configured using command-line flags, environment variables, or a configuration file. Configuration is handled with the following precedence (highest to lowest):