gmgauthier/grokkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 11 Wiki Activity
d377e6b345
grokkit/docs/user-guide/completion.md
Greg Gauthier cd47686679
All checks were successful
CI / Test (pull_request) Successful in 42s
Details
CI / Lint (pull_request) Successful in 27s
Details
CI / Build (pull_request) Successful in 23s
Details
docs: refactor README and docs structure for better organization 
- 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.
2026-03-07 22:42:43 +00:00

908 B
Raw Blame History

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

grokkit completion bash | sudo tee /etc/bash_completion.d/grokkit

Zsh (oh-my-zsh)

grokkit completion zsh > ~/.oh-my-zsh/completions/_grokkit

Fish

grokkit completion fish > ~/.config/fish/completions/grokkit.fish

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.