Greg Gauthier
cd47686679
- Simplified README.md by moving detailed command docs, workflows, and development info to dedicated user-guide/ and developer-guide/ directories. - Created index.md files for both guides to improve navigation. - Extracted individual command guides (e.g., chat.md, edit.md) into user-guide/ for focused, maintainable documentation. - Moved architecture, configuration, and troubleshooting to developer-guide/. - Updated README links to point to the new docs structure.
43 lines
908 B
Markdown
43 lines
908 B
Markdown
# Completion Guide
|
|
|
|
The `completion` command generates shell completion scripts for Grokkit, making it faster and easier to use the CLI by providing tab-completion for commands and flags.
|
|
|
|
### Supported Shells
|
|
|
|
- **Bash**
|
|
- **Zsh**
|
|
- **Fish**
|
|
- **PowerShell**
|
|
|
|
### Installation
|
|
|
|
To enable completions, you need to generate the script for your shell and source it.
|
|
|
|
#### Bash
|
|
|
|
```bash
|
|
grokkit completion bash | sudo tee /etc/bash_completion.d/grokkit
|
|
```
|
|
|
|
#### Zsh (oh-my-zsh)
|
|
|
|
```zsh
|
|
grokkit completion zsh > ~/.oh-my-zsh/completions/_grokkit
|
|
```
|
|
|
|
#### Fish
|
|
|
|
```fish
|
|
grokkit completion fish > ~/.config/fish/completions/grokkit.fish
|
|
```
|
|
|
|
#### PowerShell
|
|
|
|
```powershell
|
|
grokkit completion powershell | Out-String | Invoke-Expression
|
|
```
|
|
|
|
### Usage
|
|
|
|
Once installed, you can simply type `grokkit ` followed by `Tab` to see available commands, or `grokkit <command> --` followed by `Tab` to see available flags.
|