# cargo-launcher

[![Build Status](https://travis-ci.com/watawuwu/cargo-launcher.svg?branch=master)](https://travis-ci.com/watawuwu/cargo-launcher)
[![Latest version](https://img.shields.io/crates/v/cargo-launcher.svg)](https://crates.io/crates/cargo-launcher)
[![Documentation](https://docs.rs/cargo-launcher/badge.svg)](https://docs.rs/crate/cargo-launcher)
![License](https://img.shields.io/crates/l/cargo-launcher.svg)

If the cargo project is a binary crates, this tool can register the binary in the following launcher.

- [Alfred](https://www.alfredapp.com/workflows/)
    - Register as workflow
- [Hain](https://hainproject.github.io/hain/docs/)
    - Register as devplugin
- [Albert](https://albertlauncher.github.io/docs/extensions/python/)
    - Register as Python extension

## Demo
Alfred:

![Preview](https://camo.qiitausercontent.com/4f154fa67b49cd18cc69188d1871e8dba9603e9a/68747470733a2f2f6d656469612e67697068792e636f6d2f6d656469612f3535353449473062524a68327830357a52492f67697068792e676966)


## Installation
cargo-launcher can be installed with cargo install:

``` shell
$ cargo install cargo-launcher
```

To upgrade:

``` shell
$ cargo install --force cargo-launcher
```

The resulting binary should then be in $HOME/.cargo/bin.

Or download binary from [gthub release page](https://github.com/watawuwu/cargo-launcher/releases).


## Usage

### Common

- Install target CLI binary(not cargo-launcher)

``` shell
$ cd {your binary crates project}

# Install to local, or manually install
#   The script path is set as follows
#   PATH=$HOME/.cargo/bin:$HOME/.local/bin:/usr/local/bin:$PATH
$ cargo install --path .
...
  Installing /Users/watawuwu/.cargo/bin/{your-binary}
```

### Alfred workflow

- Generate Alfredworkflow file

```
$ cargo launcher alfred
```

- Install to Alfred

<img src="alfred.png" width="300px">

<img src="workflow.png" width="300px">

### Hain plugin

- Export to hain devplugin directory

```
$ cargo launcher hain
```

- Restart Hain


### Albert plugin

- Export to albert module directory

```
$ cargo launcher albert
```

- Check the checkbox of the python extension list and activate the setting

<img src="albert.png" width="300px"/>

### Option

```
This CLI is a simple utility to register in lancher(alfred or hain).

USAGE:
    cargo launcher [OPTIONS] <launcher>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -b, --bin <bin_name>
    -i, --icon <icon_path>

ARGS:
    <launcher>
```