Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/SGizek/Raiku/llms.txt

Use this file to discover all available pages before exploring further.

Raiku ships a completion generator for bash, zsh, fish, and PowerShell. Once installed, pressing Tab in your shell will complete Raiku subcommands, flags, and package names pulled from the local index — so you can type raiku install fast<Tab> and get fast-math without remembering exact names. Completions are generated using Click’s built-in completion mechanism and are appended to your shell’s startup file by raiku completion <shell> --install.

​
Installing Completions

Auto-install (appends the eval snippet to ~/.bashrc):
raiku completion bash --install
After running, restart your shell or reload your config:
source ~/.bashrc
Manual install (if you prefer to manage your dotfiles yourself):
raiku completion bash >> ~/.bashrc && source ~/.bashrc
The snippet appended to ~/.bashrc looks like:
# raiku completion
eval "$(_RAIKU_COMPLETE=bash_source raiku)"

​
Printing the Script Without Installing

Omit --install to print the completion script to standard output instead of writing it to any file. This is useful for reviewing the script before committing it to your dotfiles, or for deploying it through a configuration management tool: 
# Print to stdout — review before installing
raiku completion bash
raiku completion zsh
raiku completion fish
raiku completion powershell
The output is displayed in a syntax-highlighted panel in your terminal, along with the recommended config file path and the command to auto-install it: 
To install automatically: raiku completion bash --install
Or manually append to ~/.bashrc

​
What Gets Completed

Completions include package names sourced from the local index at ~/.raiku/index.json. Run raiku sync to refresh the index if newly published packages are not appearing as completion candidates.
Once completions are active, Tab will complete:
  • Subcommands — install, search, update, outdated, uninstall, pin, list, sync, info, audit, stats, doctor, config, trust, completion, init, validate, publish, index, cache
  • Flags — all flags for the current subcommand, e.g. --language, --tag, --limit, --trust, --no-build, --force, --lock, --all, --dry-run, --yes, --version
  • Package names — for commands that accept a package argument (install, update, uninstall, pin add, pin remove, info, trust add, trust remove)
# Examples of what Tab-completion enables
raiku install fast<Tab>         # → fast-math
raiku update --<Tab>            # → --all  --dry-run
raiku pin add <Tab>             # → list of installed packages
raiku completion <Tab>          # → bash  zsh  fish  powershell

Build docs developers (and LLMs) love

Get started for freeTalk to us