User Guide

This section describes how to use the features of Alfred-PyWorkflow.

If you’re new to writing workflows or coding in general, start with the Tutorial.

Tip

If you’re writing a workflow that uses data from the system (e.g. from files/the filesystem or via command-line programs called via subprocess), please read Encoded bytest and strings, which describes how to handle data from sources other than Alfred-PyWorkflow’s APIs.

• Workflow setup and skeleton
• Including 3rd party libraries
• Persistent data
  • Caching data
  • Session-scoped cache
  • Storing data
  • Settings
  • Keychain access
  • A note on Script Behaviour
• Searching/filtering data
  • Using “Alfred filters results”
  • Fuzzy filtering with Alfred-PyWorkflow
• Retrieving data from the web
• Notifications
  • Usage
• Background processes
• Self-updating
  • GitHub releases
  • Configuration
  • Usage
  • Under the hood
  • Version numbers
• Versioning and migration
  • Setting a version number
  • Version numbers
  • First run/migration
• System icons
  • List of icons
• “Magic” arguments
  • Customising magic arguments
• Workflow variables
  • Getting variables
  • Setting variables from Run Script actions
  • Setting variables in Script Filters
  • Persisting variables
  • More information
• Serialization of stored/cached data
  • Built-in serializers
  • Managing serializers
  • Serializer interface
• Re-running a Script Filter
• Encoded bytest and strings
  • TL;DR
  • String types
  • Normalization
  • Other Gotchas
  • Further information