Giter VIP home page Giter VIP logo

alfredo's Introduction

Alfredo

Build Status Coverage 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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.