Skip to content

SamVerschueren/alfred-link

Repository files navigation

alfred-link Build Status

Make your Alfred workflows installable from npm

Install

$ npm install --save alfred-link

Supporting Versions

  • Alfred 3
  • Alfred 4

This package will only affect the latest one if you have multiple versions in your system.

Usage

Add the alfred-link command as postinstall script of your Alfred package and add alfred-unlink as preuninstall script to clean up the resources when the workflow gets uninstalled.

{
  "name": "alfred-unicorn",
  "scripts": {
    "postinstall": "alfred-link",
    "preuninstall": "alfred-unlink"
  }
}

You can now install the alfred-unicorn package like this

$ npm install -g alfred-unicorn

This will update info.plist with the information from package.json and creates a unicorn symlink inside the Alfred workflows directory that points to the location of the alfred-unicorn module.

info.plist

This package will update the info.plist file when the workflow is being installed. The following properties in info.plist can be safely omitted. The corresponding values in package.json are added to the plist file.

info.plist package.json
version version
description description
webaddress homepage
createdby author.name

Development

When developing an Alfred workflow, you can call alfred-link directly from your cli. Use npx to call the local installation of alfred-link and alfred-unlink.

$ npx alfred-link

This will create a symlink in the Alfred workflows directory pointing to your development location without transforming info.plist.

To remove the symlink afterwards, you can call alfred-unlink.

$ npx alfred-unlink

Related

  • alfy - Create Alfred workflows with ease

License

MIT © Sam Verschueren

About

Make your Alfred workflows installable from npm

Resources

License

Stars

Watchers

Forks

Packages

No packages published