Skip to content

danielbayley/awm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

awm(1) -- Alfred Workflow Manager

SYNOPSIS

awm command [--options] [arguments]

DESCRIPTION

Extend homebrew-alfred to manage your Alfred workflow* development cycle from the command line.

* Requires the paid Powerpack upgrade.

INSTALL

brew(1) tap danielbayley/alfred
brew(1) install awm

OPTIONS

command [options]/arguments --help
-[-h]elp Display this helpful summary.
-[-v]ersion Print the installed version of awm.
--workflows Print the workflows installation path. brew(1) alfred --workflows alias.
info [alfred-]workflow Display information about the given workflow[s]. brew(1) alfred info alias.
list/ls List installed workflows. brew(1) alfred list alias.
[un]install/rm/zap [alfred-]workflow [un]install the given workflow[s]. brew(1) alfred [un]install/zap alias.
update Update all workflows. brew(1) alfred update alias.
disable/enable [alfred-]workflow Toggle activation of the given workflow[s] in Alfred.
init [**/folder] git(1) initialise a workflow based on the project template.
--template **/template Specify a path to override the default workflow template. This takes precedence over HOMEBREW_AWM_TEMPLATE.
dev[elop] [alfred-]workflow git(1) clone or download an existing workflow, ready for local development.
--icon ["App Name"/*.app] Generate a workflow icon with librsvg if an icon.svg is present, or copy from a given app. Should the workflow bundle ID exactly match that of an existing app, then the corresponding icon is copied. osascript(1) -e 'id of app "Name"' will give you the bundle ID of any app.
[un]link Symlink or unlink the current directory into the workflows install path for Alfred to [un]load.
prune Remove any broken symlinks in the workflows install path. brew(1) alfred prune alias.
test Run any pre-commit hook, or npm(1) test if a package.json is present.
[un]publish [M]ajor/ [m]inor/ [p]atch Bump the Semantic Version number and cut a release using ghr.
[v]M.m.p/--amend Manually specify a version, or --amend the latest release. Existing given versions will be --amended.
--preview List contents of the previously generated .alfredworkflow.
-[-i]nclude gl*b Force inclusion of any extra uncommitted files matching the given glob pattern. These are passed to the underlying zip(1) command. Multiple patterns can be specified with additional -[-i]nclude patterns.
-[-t]itle Specify a release title, other than the default (vM.m.p).
-[-d]escription Describe this release.

EXAMPLES

Note that the alfred- prefix is optional when passing workflow names as arguments, of which multiple can be given.

  • awm info things alfred-numi: Display brew(1) alfred information about alfred-things and alfred-numi.

  • awm develop numi: git(1) clone the associated repository and reinitialise it,
    running any post-checkout hook, then awm link it into the
    workflows install path, ready for local development.

  • awm publish major -t "First Release": Generate the .alfredworkflow and cut a v1.0.0 (if initial) release, with the given --title.

  • awm publish --amend -i \*.md: Add any uncommited markdown files to the previous release.

ENVIRONMENT

Export a HOMEBREW_AWM_TEMPLATE variable with a specified path to override the default workflow template.

BUGS

Open an issue

AUTHOR

Daniel Bayley daniel.bayley@me.com

COPYRIGHT

MIT (C) 2018 Daniel Bayley

SEE ALSO

Homebrew
External command
homebrew-alfred

Alfred
Powerpack
Workflow

Template
Bundle ID

git(1) init
Templates
pre-commit hook
post-checkout hook

package.json
npm(1) test

Glob patterns
Sym[bolic] links

Semantic Versioning
GitHub Releases
ghr

librsvg

brew(1), curl(1), git(1), npm(1), rsvg-convert(1), zip(1), zsh(1)