Quickstart

To start using the Bundler, generally, you need to

  1. download the language-appropriate bundlet,
  2. place it in your workflow's root directory, and then
  3. include and instantiate it in each script.

The bundlet will install the Bundler into the Alfred data directory and just start working like magic. Specific implementations vary by language, so see the quickstart page for the language you're using.

If you want to implement the bundler with another language, then just use the Bash bundlet as an executable. Read below for more information.

Assets

Most assets are defined through a JSON file. The bundler includes several defaults to use, but you can add your own if necessary.

Updates

For minor updates, the Bundler will update itself automatically. These updates will include security and bug fixes, yet they might also introduce new features; however, no minor update will ever change the Bundler's API, so you needn't worry about updating your workflow to account for changes in a new minor versions.

The bundlet should never need updating; however, if a major bugfix is needed, then a post will be made, and you will need to update the bundlet in your workflow. The bundlet will work with the bundler for all minor updates of a major version (Aries, Taurus, Gemini, etc...)

Implementation

We suggest reading the implementation page for more information about how to initialize the Bundler.

Find more for a particular language

Implementing the Bundler in another language

  1. Download the Bash bundlet, and place it in your workflow's root directory.
  2. Use the bundler as a system executable.
Load a Utility

./alfred.bundler.sh 'utility' 'Pashua' 'latest'

Load an Icon

./alfred.bundler.sh 'icon' 'elusive' 'fire' 'abcdef' 'true'

See the Bash documentation for more information about the arguments for loading assets and icons.

When using the Bash bundlet as an executable, pass four arguments at most to load an asset: type name version json_path. Read more about default assets.

For icons, pass five at most. Whenever you load an icon, the first argument needs to be icon. So, if you were to pass all five, they would be icon font name color alter. Read more about icon arguments.

Questions?

Post on the Alfred Forum thread.

Bug Reports?

Open an issue in the Github queue.