afwf

Automate building and testing Alfred Script Filter workflows with the afwf SDK.

Updated Apr 25, 2022
One-click install
npx skills add https://github.com/MacHu-GWU/afwf_github-project --skill afwf
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: afwf
Source: https://github.com/MacHu-GWU/afwf_github-project/tree/main/.claude/skills/afwf
Command: npx skills add https://github.com/MacHu-GWU/afwf_github-project --skill afwf

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This guide helps developers build, modify, test, and deploy Alfred Script Filter workflows using the afwf SDK, reducing boilerplate and keeping references in one place.

Core Features & Use Cases

  • Architected across three layers: Python logic, CLI entry point, and Alfred workflow config, enabling clean separation of concerns.
  • Complete reference for common AFWF patterns like fuzzy matching, disk caching, and write actions, including practical deployment guidance.
  • Real-world workflows illustration and best practices for testing, logging, and packaging the SDK-driven projects.

Quick Start

Install afwf, define a ScriptFilter main function, and call send_feedback() to return items to Alfred.

Frequently Asked Questions about afwf

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build Alfred Script Filter workflows using Python?

You can build Alfred Script Filter workflows using Python by defining a ScriptFilter main function, implementing your logic, and calling send_feedback() to return items to Alfred. The afwf SDK handles the integration and reduces boilerplate.

What is the best way to structure an Alfred workflow with Python and a CLI?

The best way to structure an Alfred workflow is using a three-layer architecture: Python logic, a CLI entry point, and Alfred workflow config. This separation of concerns keeps your codebase clean and maintainable.

Can I implement fuzzy matching and disk caching in Alfred workflows?

Yes, you can implement fuzzy matching and disk caching in Alfred workflows. The afwf SDK provides complete references and patterns for these common features, allowing you to enhance search performance and reduce redundant processing.

How do I test and package an Alfred workflow built with Python?

You test and package an Alfred workflow by following best practices for testing and logging, then configuring a publish-ready pyproject.toml entry point. The SDK-driven project structure supports standard Python packaging workflows.

Does the afwf SDK support write actions for modifying Alfred items?

Yes, the afwf SDK supports write actions. It provides complete references for common AFWF patterns including write actions, enabling your Python workflows to modify and update items directly within Alfred.