An open API service indexing awesome lists of open source software.

https://github.com/jonasbn/bash_completion_carton

Incredibly basic bash completion for Perl's magnificent Carton
https://github.com/jonasbn/bash_completion_carton

bash bash-completion carton hacktoberfest shell

Last synced: 4 months ago
JSON representation

Incredibly basic bash completion for Perl's magnificent Carton

Awesome Lists containing this project

README

        

# Carton Bash Completion

Incredibly basic `bash` completion for Perl's [carton](https://github.com/perl-carton/carton).

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Usage

```
$ carton
bundle exec help install
```

See [carton](https://github.com/perl-carton/carton) for more information on the different commands available to `carton`, can also be retrieved via `carton help`.

`install` offers additional completions.

```
$ carton install
--cached --deployment
```

## Download

```bash
$ curl https://raw.githubusercontent.com/jonasbn/bash_completion_carton/master/carton > carton
```

## Installation

Where your completions are located might vary.

### Personal

If you want to install them for your personal use, do the following.

Create the file: `~/.bash_completion`, containing the code below:

```bash
for bcfile in ~/.bash_completion.d/* ; do
. $bcfile
done
```

Ref: [ServerFault.com: _Standard place for user defined bash_completion.d scripts?_](https://serverfault.com/questions/506612/standard-place-for-user-defined-bash-completion-d-scripts)

Create a directiory for your completions:

```bash
$ mkdir ~/.bash_completion.d
```

Copy your completions into the newly created directory:

```bash
$ cp carton ~/.bash_completion.d/
```

Start a new shell and you should be good to go.

### System-wide example from Debian

Based on [an introduction](https://debian-administration.org/article/316/An_introduction_to_bash_completion_part_1) to `bash` completions on Debian.

```bash
$ sudo cp carton /etc/bash_completion.d/
```

### System-wide example from OSX

This assumes you are using **Homebrew**

Do note that paths vary based on whether you are using `bash` 3 or 4

#### `bash` 3 (Formula: `bash-completions`):

```bash
$ cp carton /usr/local/etc/bash_completion.d/
```

And to activate right away:

```bash
$ source /usr/local/etc/bash_completion.d/carton
```

#### `bash` 4 (Formula: `bash-completions2`)

```bash
$ cp carton /usr/local/share/bash-completion/completions/
```

And to activate right away:

```bash
$ source /usr/local/share/bash-completion/completions/carton
```

## Motivation

`carton` is an important tool in my toolchain, so I wanted to have easy access to all the options available.

## See Also

A more elaborate piece of documentation on `bash` completions is available from **The Linux Documentation Project** in the [Advanced Bash-Scripting Guide](http://tldp.org/LDP/abs/html/tabexpansion.html).

From the [GNU Documentation](https://www.gnu.org/software/bash/manual/html_node/Programmable-Completion.html).

Good two-part article, "An Introduction to Bash Completion": [Part 1](https://debian-administration.org/article/316/An_introduction_to_bash_completion_part_1) and [Part 2](https://debian-administration.org/article/317/An_introduction_to_bash_completion_part_2).

Please note that this experimental implementation has only been tested with `bash` version 3.

The most comprehensive collection of `bash` completions I have come across is [the one](https://github.com/scop/bash-completion) from the **Debian Linux distribution**. It is also the one offered for OSX via **Homebrew**.

## License

This is made available under the MIT license, see separate license file.

## Copyright

:copyright: jonasbn 2016-2017