docs: Added documentation on cli shell autocompletion integration.#427
docs: Added documentation on cli shell autocompletion integration.#427FXschwartz wants to merge 3 commits intoserverpod:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for CLI shell autocompletion integration using Carapace, providing users with tab-completion capabilities for Serverpod CLI commands across multiple shells (bash, zsh, fish, PowerShell, etc.).
Changes:
- Added new documentation file explaining how to install and configure shell completion via Carapace
- Provided shell-specific setup instructions for bash and zsh
- Included links to external Carapace resources for other shells
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
marcelomendoncasoares
left a comment
marcelomendoncasoares
left a comment
There was a problem hiding this comment.
Thanks for the quick PR with the docs, @FXschwartz! Only a few suggestions for improvement.
| Install Carapace for your platform: | ||
|
|
||
| ```bash | ||
| brew install carapace | ||
| ``` | ||
|
|
||
| For other platforms, see the [Carapace installation guide](https://carapace-sh.github.io/carapace-bin/install.html). |
There was a problem hiding this comment.
Suggestion: Besides linking the official docs, have a brief example on how to setup for the three main platforms: MacOS (already), Ubuntu and Windows.
| @@ -0,0 +1,54 @@ | |||
| # Command line completion | |||
|
|
|||
| As a `serverpod` user, you can enable command line completion in most shells. The Serverpod CLI supports completion through [Carapace](https://carapace.sh/), which provides tab-completion for commands, options, and their values in bash, zsh, fish, PowerShell, and more. | |||
There was a problem hiding this comment.
Suggestion: Have a section in the end showing the support of completely and a brief explanation on the difference between them - although the preferred might be Carapace -, since it is shown as option for the --tools parameter.
2 participants
Cover usage over PR - serverpod/serverpod#4730
@marcelomendoncasoares Docs submitted for the CLI shell completion! Let me know what kind of changes you'd like made.