ak

README

Go base Alfred workflow generator

A generator for golang Alfred workflow that helps you create boilerplate code.

Why ?

As a Gopher, i want to create a Golang base workflow quickly than sketching it out by hand. I also want to be able to share my way of doing things with others.

Features

1. Create a new workflow with three type of patterns:
   1. Simple workflow with Alfred variables and arguments
   2. leverage deanishe/awgo with Alfred items feedback
   3. leverage deanishe/awgo and spf13/cobra with Alfred items feedback
2. Workflow development
   1. Build the workflow executable and output it into the ".workflow" subdirectory
   2. Display information about the workflow
   3. Link the ".workflow" subdirectory into Alfred's preferences directory, installing it.
   4. Package the workflow for distribution locally
   5. Unlink the ".workflow" subdirectory from Alfred's preferences directory, uninstalling it.
3. Additional patterns
   1. Add Github Action release to project
   2. Add license to project
4. Support arm64 & amd64

Installation

With Go 1.17 or higher:

go install github.com/cage1016/ak@latest

Running the generator

A generator for awgo that helps you create boilerplate code

Usage:
  ak [flags]
  ak [command]

Available Commands:
  add         Used to add additional component to project
  alfred      Used to manage Go-based Alfred workflows
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  init        Initiates a workflow
  new         Used to create workflow package

Flags:
  -d, --debug           If you want to se the debug logs.
      --folder string   If you want to specify the base folder of the workflow.
  -f, --force           Force overwrite existing files without asking.
  -h, --help            help for ak
      --testing         If testing the generator.
  -v, --version         version for ak

Use "ak [command] --help" for more information about a command.

1. ak init to create a new workflow

2. revise ak.json as your workflow's information

   {
       "go_mod_package": "github.com/xxx/ak-test",
       "workflow": {
           "folder": ".workflow",
           "name": "Ak Test",
           "description": "",
           "category_comment": "category: Tools, Internet, Productivity, Uncategorised",
           "category": "",
           "bundle_id": "com.xxx.aktest",
           "created_by": "",
           "web_address": "https://github.com/xxx/ak-test",
           "version": "0.1.0"
       },
       "update": {
           "github_repo": "https://github.com/xxx/ak-test"
       },
       "license": {
           "type_comment": "support license https://github.com/nishanths/license",
           "type": "mit",
           "year": "",
           "name": ""
       },
       "gon": {
           "application_identity": "Developer ID Application: KAI CHU CHUNG"
       }
   }    
   

3. Create one of three different workflow patterns

   1. ak new varsArgs create a workflow with variables and arguments
   2. ak new iterms create a workflow with items feedback
   3. ak new cliItems create a workflow with cobra items feedback

4. Add additional components to the workflow

   1. ak add githubAction add Github Action release to project
      1. -s true to enable code sign and notarize
   2. ak add license add license to project

5. Workflow development

   1. ak alfred build to build the workflow executable and output it into the ".workflow" subdirectory
   2. ak alfred info to display information about the workflow
   3. ak alfred link to link the ".workflow" subdirectory into Alfred's preferences directory, installing it.
   4. ak alfred package to package the workflow for distribution locally
   5. ak alfred unlink to unlink the ".workflow" subdirectory from Alfred's preferences directory, uninstalling it.

Examples

1. ak/_examples/varsArgs
2. ak/_examples/items
3. ak/_examples/cliItems

License

This project is licensed under the MIT License. See LICENSE for details.

Documentation

Overview

Copyright © 2022 KAI CHU CHUNG <cage.chung@gmail.com>