Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deanishe/awgo
Go library for Alfred 3 + 4 workflows
https://github.com/deanishe/awgo
alfred alfred-3 alfred-4 alfred-workflow alfred3 alfred3-workflow alfred4 alfred4-workflow alfredworkflow awgo fuzzy fuzzy-search gitea github go golang workflow
Last synced: about 1 month ago
JSON representation
Go library for Alfred 3 + 4 workflows
- Host: GitHub
- URL: https://github.com/deanishe/awgo
- Owner: deanishe
- License: mit
- Created: 2017-09-08T17:53:10.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-03T07:40:57.000Z (5 months ago)
- Last Synced: 2024-06-19T12:47:17.914Z (3 months ago)
- Topics: alfred, alfred-3, alfred-4, alfred-workflow, alfred3, alfred3-workflow, alfred4, alfred4-workflow, alfredworkflow, awgo, fuzzy, fuzzy-search, gitea, github, go, golang, workflow
- Language: Go
- Homepage: https://godoc.org/github.com/deanishe/awgo
- Size: 8.79 MB
- Stars: 853
- Watchers: 9
- Forks: 44
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred-test - deanishe/awgo - Go library for Alfred 3 + 4 workflows (Go)
- awesome-golang-repositories - awgo
- alfred-workflows - AwGo - Write workflows in Go. (Libraries)
README
# AwGo — A Go library for Alfred workflows #
[![Build Status][ghaction-badge]][ghaction-link]
[![Go Report Card][goreport-badge]][goreport-link]
[![Coverage Status][coveralls-badge]][coveralls-link]
[![Go Reference][godoc-badge]][godoc-link]
Full-featured library to build lightning-fast workflows in a jiffy.
- [Features](#features)
- [Installation & usage](#installation--usage)
- [Documentation](#documentation)
- [Requirements](#requirements)
- [Development](#development)
- [Licensing & thanks](#licensing--thanks)
## Features ##
- Full support for Alfred 3 & 4
- Bi-directional interface to [workflow's config][config]
- Fluent API for generating [Script Filter JSON][feedback]
- [Fuzzy sorting/filtering][fuzzy]
- [Simple, powerful API][cache-api] for [caching/saving workflow data][cache]
- Keychain API to [securely store (and sync) sensitive data][keychain]
- Helpers to [easily run scripts and script code][scripts]
- Workflow [update API][update] with built-in support for [GitHub][update-github] & [Gitea][update-gitea]
- [Pre-configured logging][logging] for easier debugging, with a rotated log file
- [Catches panics, logs stack trace and shows user an error message][run]
- ["Magic" queries/actions][magic] for simplified development and user support
- macOS [system icons][icons]
## Installation & usage ##
Install AwGo with:
```sh
go get -u github.com/deanishe/awgo
```
Typically, you'd call your program's main entry point via `Workflow.Run()`.
This way, the library will rescue any panic, log the stack trace and show
an error message to the user in Alfred.
program.go:
```go
package main
// Package is called aw
import "github.com/deanishe/awgo"
// Workflow is the main API
var wf *aw.Workflow
func init() {
// Create a new Workflow using default settings.
// Critical settings are provided by Alfred via environment variables,
// so this *will* die in flames if not run in an Alfred-like environment.
wf = aw.New()
}
// Your workflow starts here
func run() {
// Add a "Script Filter" result
wf.NewItem("First result!")
// Send results to Alfred
wf.SendFeedback()
}
func main() {
// Wrap your entry point with Run() to catch and log panics and
// show an error in Alfred instead of silently dying
wf.Run(run)
}
```
In the Script Filter's Script box (Language = /bin/bash with input as
argv):
```sh
./program "$1"
```
## Documentation ##
Read the docs [on pkg.go.dev][godoc].
Check out the [example workflows][examples-code] ([docs][examples-docs]), which
show how to use AwGo. Use one as a template to get your own workflow up and
running quickly.
## Requirements ##
The library (and therefore the unit tests) rely on being run in a minimally
Alfred-like environment, as they pull configuration options from the environment
variables set by Alfred.
This means that if you want to run AwGo-based code outside Alfred, e.g. in your
shell, you must set at least the following environment variables to meaningful
values, or the library will panic:
- `alfred_workflow_bundleid`
- `alfred_workflow_cache`
- `alfred_workflow_data`
And if you're using the update API, also:
- `alfred_workflow_version`
- `alfred_version` (not needed for Alfred 4+)
## Development ##
To create a sufficiently Alfred-like environment, you can `source` the `env.sh`
script in the project root or run unit tests via the `run-tests.sh` script
(which also sets up an appropriate environment before calling `go test`).
## Licensing & thanks ##
This library is released under the [MIT licence][licence]. It was built with
[neovim][neovim] and [GoLand by JetBrains][jetbrains].
The icon is based on the [Go Gopher][gopher] by [Renee French][renee].
[alfred]: https://www.alfredapp.com/
[licence]: ./LICENCE
[godoc]: https://pkg.go.dev/github.com/deanishe/awgo
[gopher]: https://blog.golang.org/gopher
[renee]: http://reneefrench.blogspot.com
[config]: https://pkg.go.dev/github.com/deanishe/awgo#Config
[feedback]: https://pkg.go.dev/github.com/deanishe/awgo#Feedback.NewItem
[fuzzy]: https://pkg.go.dev/github.com/deanishe/awgo/fuzzy
[cache]: https://pkg.go.dev/github.com/deanishe/awgo#hdr-Storing_data
[cache-api]: https://pkg.go.dev/github.com/deanishe/awgo#Cache
[run]: https://pkg.go.dev/github.com/deanishe/awgo#Run
[keychain]: https://pkg.go.dev/github.com/deanishe/awgo/keychain
[scripts]: https://pkg.go.dev/github.com/deanishe/awgo/util#hdr-Scripting
[update]: https://pkg.go.dev/github.com/deanishe/awgo/update
[update-github]: https://pkg.go.dev/github.com/deanishe/awgo/update#GitHub
[update-gitea]: https://pkg.go.dev/github.com/deanishe/awgo/update#Gitea
[logging]: https://pkg.go.dev/github.com/deanishe/awgo#hdr-Logging
[magic]: https://pkg.go.dev/github.com/deanishe/awgo#MagicAction
[icons]: https://pkg.go.dev/github.com/deanishe/awgo#Icon
[examples-code]: https://github.com/deanishe/awgo/tree/master/_examples
[examples-docs]: https://pkg.go.dev/github.com/deanishe/awgo/_examples
[jetbrains]: https://www.jetbrains.com/?from=deanishe/awgo
[neovim]: https://neovim.io/
[godoc-badge]: https://pkg.go.dev/badge/github.com/deanishe/awgo.svg
[godoc-link]: https://pkg.go.dev/github.com/deanishe/awgo
[goreport-link]: https://goreportcard.com/report/github.com/deanishe/awgo
[goreport-badge]: https://goreportcard.com/badge/github.com/deanishe/awgo
[azure-badge]: https://img.shields.io/azure-devops/build/deanishe/6cd8e4fe-7366-4485-aea6-e9d75e7757b2/1
[azure-link]: https://dev.azure.com/deanishe/AwGo/_build
[ghaction-badge]: https://github.com/deanishe/awgo/workflows/CI/badge.svg
[ghaction-link]: https://github.com/deanishe/awgo/actions?query=workflow%3ACI
[coveralls-badge]: https://coveralls.io/repos/github/deanishe/awgo/badge.svg?branch=master&v3
[coveralls-link]: https://coveralls.io/github/deanishe/awgo?branch=master