https://github.com/j3lte/alfredo
Your Alfred workflows on steroids with Deno
https://github.com/j3lte/alfredo
alfred alfred4 alfred4-workflow
Last synced: 6 months ago
JSON representation
Your Alfred workflows on steroids with Deno
- Host: GitHub
- URL: https://github.com/j3lte/alfredo
- Owner: j3lte
- License: mit
- Created: 2022-07-11T09:55:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-24T16:37:14.000Z (about 3 years ago)
- Last Synced: 2025-04-16T07:21:07.700Z (6 months ago)
- Topics: alfred, alfred4, alfred4-workflow
- Language: TypeScript
- Homepage:
- Size: 355 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Alfredo
Run your Alfred workflows in Deno
[](https://github.com/j3lte/alfredo)
[](https://github.com/j3lte/alfredo)
[](https://github.com/j3lte/alfredo/actions/workflows/main.yml)
[](https://github.com/denoland/deno)
[](https://github.com/denoland/deno)
This is a Deno library, inspired by [Alfy](https://github.com/sindresorhus/alfy)
(a Node.JS library for running Alfred workflows).
> ⚠️ This project is work in progress. Expect breaking changes.
#### Quick links
- [API Reference](https://doc.deno.land/https://deno.land/x/alfredo/mod.ts)
## Client
Install the client:
```
deno install --allow-read --allow-write --allow-env -f --reload -n alfredo https://deno.land/x/alfredo/cli.ts
```
You can use the client to scaffold a new Alfred Workflow
```
$ alfredo --help
Usage: alfredo
Version: 0.1.0
Description:
Let's do Deno things in Alfred (https://www.alfredapp.com/)
Options:
-h, --help - Show this help.
-V, --version - Show the version number for this program.
Commands:
generate [folder] - Generate a Alfred workflow
link [folder-name] - Link the folder to the Alfred workflow folder
unlink [folder-name] - Unlink the folder to the Alfred workflow folder
```
### Generate
Run the client:
```
alfredo generate
```
Where:
- `identifier` needs to be a unique identifier, something like
`com.alfredo.somethinguseful` (it's totally up to you)
- `foldername` is optional. If you omit it, alfredo will try to scaffold one in
the current folder, otherwise it will create a folder with `foldername`
This will add the following to the folder:
- `run.ts` A script to get you started, with a link to the Alfredo library on
Deno.land
- `icon.png` This icon will be used in the workflow, obviously you can replace
that when you start editing the workflow in Alfred
- `info.plist` A starting workflow file that is automatically picked up by
Alfred. You should start by editing the name, description etc in the workflow
in Alfred.
#### The starter workflow
The starter workflow will be a Script Filter Input (Inputs -> Script Filter)
with the following settings:
- Keyword: Set a usefull keyword to be used by Alfred to determine if it needs
to run the script
- Language: Personally I am using Zsh, so I set this to `/bin/zsh`
- You should set the script to `with input as argv`, but obviously that is up to
you
- Script:
```sh
#!/bin/sh
if [ -f "/opt/homebrew/bin/deno" ]
then
/opt/homebrew/bin/deno run -A run.ts "$@"
elif [ -f "$HOME/.deno/bin/deno" ]
then
"$HOME/.deno/bin/deno" run -A run.ts "$@"
fi
```
> Note: Because I have installed Deno using Homebrew, I will run it from
> '/opt/homebrew'. You can find it out yourself by testing in your terminal
> where the `deno` bin is: `which deno`. For the starter script I am keeping it
> as generic as possible
### Link
```
alfredo link
```
This will try to link the folder to your Alfred workflow folder. Alfredo will
try to determine this by checking for the workflow folder in your Alfred
settings
### Unlink
```
alfredo unlink
```
This will try to unlink the folder from your Alfred workflow folder. Note that
it will fail if it can't find the folder, or determine the folder in your Alfred
workflow folder to not be a symlink.
## Library
> Coming soon
## License
MIT License