# 3llo - Interactive CLI for Trello

3llo is the terminal client for Trello, which helps you manage Trello cards without
leaving your awesome terminal.

[![video](intro.gif)](https://asciinema.org/a/0z3l05hwph3vdq91gu7n1m3o4)

3llo was inspired by the awesome
[rainbowstream](https://github.com/DTVD/rainbowstream) and
[facy](https://github.com/huydx/facy).

## Why this named 3llo?

Good to know that `3 == "tre"` in Swedish.

## Installation

```ruby
gem install 3llo
```

You also need to have these environment variables set in your shell.

```
export TRELLO_USER=your_username
export TRELLO_KEY=your_key
export TRELLO_TOKEN=your_token
```

### Obtain Trello API key and token

1. Ensure you're logged into your Trello account at [trello.com](https://trello.com)
1. Visit [trello.com/app-key](https://trello.com/app-key), accept the Trello Developer Terms (if you're happy to do so) and press **Generate API Key**
1. Copy the `Key` that's displayed at the top of the page and set this as an environment variable (`TRELLO_KEY`).
1. Further down the page, follow the `Manually generate a token` link to generate a new API Token. Again, set this as an environment variable (`TRELLO_TOKEN`)

## Usage

There are a couple of commands available in 3llo.

* `board list`: List your board
* `board select <board_id>`: Select the active board.
* `card list`: List all cards of the active board.
* `card list mine`: List all your cards of the active board.
* `card add`: Create a card.
* `card show <card_id>`: Show card information.
* `card move <card_id> <list_id>`: Move card to a specified list.
* `card self-assign <card_id>`: Self-assign a card.
* `card comments <card_id>`: Show recent comments of a card.
* `card comment <card_id>`: Add a comment to a card.
* `card archive <card_id>`: Archive a card.
* `list list`: List all the lists of the active board.
* `list archive-cards <list_id>`: Archives all the cards on the specified list.
* `help`: Show help menu.
* `exit`: Exit.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/qcam/3llo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

### Development Roadmap

View in [Issues](https://github.com/qcam/3llo/issues)

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).