Nutrella

A command line tool for associating a Trello board with the current git branch.

Table of Contents

• Installation
• Usage
• Troubleshooting
• Origin of Name
• Contributing
• License

Installation

Step 1: Install gem

$ gem install nutrella

Step 2: Create configuration file

$ nutrella

Step 3: Get key and secret (best to do this from your home directory)

$ cd ~
$ irb -r rubygems
irb> require 'nutrella'
irb> Nutrella.open_public_key_url

Insert your key and secret into your ~/.nutrella.yml file.

Step 4: Get token

irb> Nutrella.open_authorization_url key: '<your_public_key_from_step_3>'

Insert your token into your ~/.nutrella.yml file.

Step 5: Update configuration file

If your haven't already done so, insert your key, secret, and token into your ~/.nutrella.yml file.

The configuration file should look like the following (don't use the keys below as they won't work for you):

    # Trello Developer API Keys
    key: c2fc703429da08b6e7dcb0a878e35564
    secret: 7fd865f372891afa93aabdb6b836254bcda10c8a320def2b3207e2ffb425bc0a
    token: 4c13558cbafdcb4765103a195e05b0476f3b3f7f3efc83f2a810fb769f4ae2d6

    # Optional Configuration
    organization: 542d76ac2fad4697c3e80448
    launch_command: open $url$
    enable_trello_app: false
    enable_logging: true
    cache_capacity: 5
    cache_first: '^PM-\d+'

Step 6: Adjust configuration file (Optional)

Adjust the launch_command configuration to fit your needs. For example, to open your Trello board in Firefox change your configuration to:

    launch_command: open -a firefox $url$

Adjust the enable_trello_app configuration to open boards in the Trello app. To open your Trello board in the Trello app change your configuration to:

    enable_trello_app: true

Adjust the enable_logging configuration to start logging diagnostics:

    enable_logging: true

Adjust the cache_capacity configuration to increase the capacity of the cache (see ~/.nutrella.cache.yml):

   cache_capacity: 15

Adjust the cache_first configuration to allow searching the cache first before creating or opening a Trello board:

   cache_first: '^(PM|QC)-\d+'

The string that you specify will be treated as a regular expression.

Usage

There are three ways to invoke the nutrella command:

1. Create or open a Trello board based on the name of the current git branch:

   $ nutrella
   

   This is the command invocation that should meet your needs 90% of the time.

2. Create or open a named Trello board using the full git branch name:

   $ nutrella <git-branch-name>
   

3. Create or open a previously created Trello board using a JIRA ticket like PM-9423:

   $ nutrella <JIRA Ticket>
   

   This behaviour relies on the cache_first configuration setting. Invoking nutrella with a JIRA ticket number is for those situations where you make multiple git branches for the same JIRA ticket with a different suffix.

Troubleshooting

1. If an unexpected Trello board is opening try clearing your cache:

   rm ~/.nutrella.cache.yml
   

2. If you see method_missing: undefined method 'this'

   Try updating RubyGems

   gem update --system
   

3. If you see uninitialized constant Gem::Source (NameError)

   Try updating bundler

   gem install bundler
   

4. If you see cannot load such file -- nutrella

   This error may appear after running irb -rubygems and you are unable to require 'nutrella'. Try running irb -rubygems from your home directory:

   cd ~
   

Origin of Name

Nutrella is a portmanteau that combines these three words: Nulogy, Trello, and Nutella.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/amckinnell/nutrella. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.