README.org

Elvish completions

This Elvish package contains various completions I and others have written for the Elvish shell.

Compatibility

These modules are only guaranteed to be fully compatible with Elvish HEAD, which is what I use. This means that occasionally, they will not work even with the latest official release, when breaking changes are introduced. Since Elvish is in active development, I highly recommend you use the latest commit too.

Installation and use

To install, use epm:

use epm
epm:install github.com/zzamboni/elvish-completions

For each module you want to use, you need to add the following to your rc.elv file:

use github.com/zzamboni/elvish-completions/<modulename>

See each module’s page for detailed usage instructions.

Modules included

The following modules are included:

builtins

Completions for some of Elvish’s built-in commands, including use, the epm module and elvish itself.

cd

Completes directory names for the cd command.

comp

A framework to easily define argument completers in Elvish. Used to implement most other modules in this repository. For a getting-started tutorial, see http://zzamboni.org/post/using-and-writing-completions-in-elvish/.

dd

Completions for dd, including operands, conversions, and flags.

evemu

Completions for =evtest= and the =evemu= set of tools, which assist in debugging and emulating the Linux input subsystem.

git

Completions for git, including automatically generated completions for both subcommands and command-line options.

ssh

Completions for ssh, scp and sftp.

vcsh

Completions for vcsh.