Wrapper script for Alfred 2 Workflows
Ruby
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.travis.yml
Gemfile
Gemfile.lock
LICENSE.txt
README.md
Rakefile
alfredo.gemspec

README.md

Alfredo

Build Status

Alfredo is wrapper for Alfred 2's new Workflow system. It generates a XML response based on the information in the Alfred Forums.

Installation

$ gem install alfredo

Usage

Using Alfredo is pretty straightforward:

require 'alfredo'

# set up the workflow
workflow = Alfredo::Workflow.new

# you can add as many items as you want like this:
workflow << Alfredo::Item.new(...)

# At the end of your script call:
workflow.output!

Parameters available for Alfredo::Item.new are:

  • title (shown in large text in the results)
  • subtitle (shown under the title in smaller text)
  • arg (argument that can be passed on to next steps in the workflow)
  • uid (value that Alfred uses to learn about your usage)
  • icon_path (path of icon or file, relative to workflow directory)
  • icon_type
    • fileicon (uses the icon associated with a file)
    • filetype (uses the icon associated with the type of a file)
  • type (when file allows result action for files)

More info is available at the Alfred Forums.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request