Question 1

How do I install an Alfy-based workflow from npm?

Accepted Answer

Run `npm install -g alfred-workflow-name`; the `postinstall` script automatically sets up the workflow in Alfred. Ensure you have Alfred Powerpack and Node.js 18+ installed first.

Question 2

What are the benefits of using Alfy over writing raw Alfred scripts?

Accepted Answer

Alfy abstracts away boilerplate for I/O, caching, and error handling, and provides utilities like `alfy.fetch` for API calls. It also integrates with npm for easier updates and testing compared to manual scripting.

Question 3

How can I handle user configuration like API tokens in Alfy?

Accepted Answer

Use `alfy.userConfig` for persistent settings or environment variables via `process.env`. The README shows examples for accessing workflow configuration, such as API keys stored by users.

Question 4

Can I use TypeScript with Alfy?

Accepted Answer

Yes, but you must compile TypeScript to JavaScript since Alfy runs on Node.js with ESM. There's no built-in TypeScript support, so additional build tools are needed.

Question 5

How do I debug my Alfy workflow when it's not working?

Accepted Answer

Use Alfred's built-in workflow debugger; Alfy logs errors with `alfy.log()` or `console.error()`, which appear in the debugger. The README includes a debugging section with examples.

Question 6

Alfy vs other Alfred workflow libraries: which should I choose?

Accepted Answer

Alfy is best for Node.js developers needing comprehensive features like caching and npm distribution. For non-JavaScript projects, alternatives like `alfred-workflow` (Python) or native scripts are more suitable.

Question 7

Is Alfy compatible with the latest version of Alfred?

Accepted Answer

Yes, Alfy supports Alfred 4 and later, including Alfred 5, as per the prerequisites. It uses Alfred's stable JSON API, so it remains compatible with new releases.

Alfy

What is Alfy?

Overview

Use Cases

Best For

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions