examples

package
Version: v0.29.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 15, 2021 License: MIT Imports: 0 Imported by: 0

README

Examples

Each subdirectory contains a complete, but trivial, Alfred workflow demonstrating AwGo features.

After building the executable, copy or symlink the directory to Alfred's workflow directory to try it out.

You can use this script to simplify installing/symlinking workflows that are still in development.

If you've installed that script on your $PATH, you can try out the examples by running:

workflow-install -s /path/to/example

which will symlink the workflow to Alfred's workflow directory.

fuzzy

Alfred 4+ only

Basic demonstration of using fuzzy filtering.

Displays and filters contents of ~/Downloads in Alfred, and allows you to open files, reveal them or browse them in Alfred.

reading-list

Demonstrates customised fuzzy sorting.

The standard fuzzy sort is only concerned with match quality. This workflow has a custom implementation of fuzzy.Sortable and fuzzy filtering to keep a list of books sorted by status ("unread", "unpublished", "read").

Regular fuzzy sorting only considers match quality, so with the query "kingkiller", the Kingkiller Chronicle series would be sorted based on where the term "kingkiller" appears in the title, i.e. shortest title wins:

The Doors of Stone (The Kingkiller Chronicle, #3)   [unpublished]
The Wise Man's Fear (The Kingkiller Chronicle, #2)  [unread]
The Name of the Wind (The Kingkiller Chronicle, #1) [read]

This custom implementation sorts by status then match quality, thus keeping unread books before unpublished and read ones:

The Wise Man's Fear (The Kingkiller Chronicle, #2)  [unread]
The Doors of Stone (The Kingkiller Chronicle, #3)   [unpublished]
The Name of the Wind (The Kingkiller Chronicle, #1) [read]

update

Demonstration of how to enable your workflow to update itself from GitHub releases.

A good template for new workflows.

workflows

Demonstrates AwGo's caching API.

Shows a list of repos from GitHub tagged alfred-workflow.

Documentation

Overview

Package examples contains trivial, but complete, Alfred workflows demonstrating features of AwGo and/or useful workflow idioms.

After building the executable, copy or symlink the directory to Alfred's workflow directory to try it out.

You can use the following script to simplify installing/symlinking workflows that are still in development:

https://gist.github.com/deanishe/35faae3e7f89f629a94e

If you've installed that script on your $PATH, you can try out the examples by running:

workflow-install -s /path/to/example/workflow

which will symlink the workflow to Alfred's workflow directory.

Source Files

Directories

Path Synopsis
Workflow fuzzy is a basic demonstration of AwGo's fuzzy filtering.
Workflow fuzzy is a basic demonstration of AwGo's fuzzy filtering.
Workflow reading-list is a more advanced example of fuzzy filtering.
Workflow reading-list is a more advanced example of fuzzy filtering.
Workflow settings demonstrates binding a struct to Alfred's settings.
Workflow settings demonstrates binding a struct to Alfred's settings.
Workflow update is an example of how to use AwGo's update API.
Workflow update is an example of how to use AwGo's update API.
Workflow workflows retrieves and filters GitHub repos tagged with "alfred-workflow".
Workflow workflows retrieves and filters GitHub repos tagged with "alfred-workflow".

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL