completion-ruby is a set of bash scripts offering command-line completion for various Ruby-related commands and tools.
These scripts depend on some utility functions from bash-completion. It should be part of pretty much any modern Linux distribution, and you can install it on macOS using Homebrew:
brew install bash-completion
Save the completion files somewhere (in the same directory) and add the
following line to your ~/.bashrc or ~/.profile:
. /path/to/completion-ruby-all
The completion-ruby-all script loads all the completions it finds,
but only for the commands you appear to have installed.
Alternatively, you can just save the specific scripts you wish, and
source them individually.
This project is considered stable. No new features are planned, and as a result it remains domant for months, but the continuous integration test suite will occasionally detect a change in behavior in a tool, and maintenance work is performed.
For information on the automated test suite, see the tests directory.
If one of the covered tools introduces a new flag that needs special treatment, please file an issue or pull request.
Before writing my own, I'd seen about five different scripts for rake
completion. None of them, though, at the same time:
- cached the task list for fast results;
- invalidated said cache when the rakefile was modified;
- worked properly with namespaces; and
- worked on subdirectories of the project
...among other minor quirks. While providing all of the above, a few other niceties were added, like command-line options completion and awareness of task arguments.
This script is not perfect (for instance, it won't update the cache if
a dependency of the rakefile is updated; as a workaround, simply
touch Rakefile), but it tries to cover all the most common cases without
overcomplicating or overthinking the code.
Copyright © 2008–2025 Daniel Luz.
completion-ruby is distributed under the MIT license.
The source is available in a Git repository at GitHub.
For up-to-date information, visit this project's permalink.