https://github.com/JoshMcguigan/shell_completion

Write shell completion scripts in pure Rust
https://github.com/JoshMcguigan/shell_completion

Last synced: 5 days ago
JSON representation

Write shell completion scripts in pure Rust

• Host: GitHub
• URL: https://github.com/JoshMcguigan/shell_completion
• Owner: JoshMcguigan
• License: apache-2.0
• Created: 2019-05-15T12:04:00.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-16T01:07:33.000Z (about 2 months ago)
• Last Synced: 2024-10-31T11:47:59.305Z (12 days ago)
• Language: Rust
• Homepage:
• Size: 29.3 KB
• Stars: 133
• Watchers: 12
• Forks: 5
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE.txt

Awesome Lists containing this project

README

        
# shell_completion [![Build Status](https://api.travis-ci.org/JoshMcguigan/shell_completion.svg?branch=master)](https://travis-ci.org/JoshMcguigan/shell_completion) [![crates.io badge](https://img.shields.io/crates/v/shell_completion.svg)](https://crates.io/crates/shell_completion)

Shell completions, which provide auto-complete for CLI applications, are typically written in Bash. This crate provides low level primitives for writing shell completion scripts in Rust. 

## Usage

Shell completion scripts are written as normal Rust binaries. A minimal example is below:

```rust

use shell_completion::{BashCompletionInput, CompletionInput, CompletionSet};

fn main() {

    let input = BashCompletionInput::from_env()

        .expect("Missing expected environment variables");

    let completions = input.complete_subcommand(vec!["add", "commit"]);

    completions.suggest();

}

```

A more advanced example is available in the `cargo_completion` crate within this workspace. To try it out, run `cargo install --force --path cargo_completion/ && complete -C _cargo_completion cargo`, then type `cargo run --` in the same shell.

The `complete` command registered our shell completion script for `cargo`. Note that `complete` commands do not persist (they are only active in the shell where you run `complete`), so if you want to use a completion long term you'll want to add the `complete` command to your `~/.bash_profile`.

See [this blog post](https://www.joshmcguigan.com/blog/shell-completions-pure-rust/) for more details.

## Users

This crate is not quite ready for production use, but if you are an early adopter, feel free to make a PR adding yourself to the list below. 

* N/A

## License

Licensed under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

### Contribution

All forms of contribution are valued. I've created issues for many high level topics of exploration, and any feedback there will be very helpful in moving this crate in the right direction. Of course, code contributions are appreciated as well. 

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.